Sensei Hub API

Account

ApiAccountSignInGet

Request

GET /api/Account/SignIn

Responses

Status Code	Type	Description	Samples
302		Redirect

ApiAccountSignOutGet

Request

GET /api/Account/SignOut

Responses

Status Code	Type	Description	Samples
302		Redirect

ApiAccountAdminConsentGet

Request

GET /api/Account/AdminConsent

Responses

Status Code	Type	Description	Samples
302		Redirect

ApiAccountGet

Request

GET /api/Account

Responses

Status Code	Type	Description	Samples
200	UserInformation	Success

AzureStorage

ApiIntegrationHubByIdAzureStorageByUsageGet

Request

GET /api/IntegrationHub/{id}/AzureStorage/{usage}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*usage
tenantId

Responses

Status Code	Type	Description	Samples
200	AzureStorageModel	Success
404		Not Found

ApiIntegrationHubByIdAzureStorageByUsageCreateSASTokenPost

Request

POST /api/IntegrationHub/{id}/AzureStorage/{usage}/CreateSASToken[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*usage
tenantId

Responses

Status Code	Type	Description	Samples
200	AzureStorageSASTokenModel	Success
404		Not Found

ApiIntegrationHubByIdAzureStorageByUsageByPolicyNameCreateSASTokenPost

Request

POST /api/IntegrationHub/{id}/AzureStorage/{usage}/{policyName}/CreateSASToken[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*usage
*policyName
tenantId
obj	CreateSASTokenModel

Responses

Status Code	Type	Description	Samples
200	AzureStorageSASTokenModel	Success
404		Not Found

ApiIntegrationHubByIdAzureStorageByUsageByPolicyNameDelete

Request

DELETE /api/IntegrationHub/{id}/AzureStorage/{usage}/{policyName}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*usage
*policyName
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

CarbonCloud

ApiCarbonCloudGet

Request

GET /api/CarbonCloud[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	BasicCarbonCloudModel[]	Success

ApiCarbonCloudByIdGet

Request

GET /api/CarbonCloud/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CarbonCloudModel	Success

ApiCarbonCloudByIdPost

Request

POST /api/CarbonCloud/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId
obj	CreateCarbonCloudOperationModel

Responses

Status Code	Type	Description	Samples
404		Not Found
403		Forbidden
400	object	Bad Request
201	CarbonCloudOperationModel	Success

ApiCarbonCloudByIdByOperationIdGet

Request

GET /api/CarbonCloud/{id}/{operationId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*operationId
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CarbonCloudOperationModel	Success

ApiCarbonCloudPackageGet

Request

GET /api/CarbonCloud/Package[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	CarbonCloudPackageModel[]	Success

ApiCarbonCloudPackageByIdGet

Request

GET /api/CarbonCloud/Package/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CarbonCloudPackageModel	Success

CarbonCloudAdmin

ApiCarbonCloudAdminGet

Request

GET /api/CarbonCloudAdmin

Responses

Status Code	Type	Description	Samples
200	CarbonCloudPackageDTO[]	Success

ApiCarbonCloudAdminPost

Request

POST /api/CarbonCloudAdmin

Parameters

Name	Type	Default	Notes
obj	CarbonCloudPackageDTO

Responses

Status Code	Type	Description	Samples
400	object	Bad Request
201	CarbonCloudPackageDTO	Success

ApiCarbonCloudAdminByIdGet

Request

GET /api/CarbonCloudAdmin/{id}

Parameters

Name	Type	Default	Notes
*id

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CarbonCloudPackageDTO	Success

ApiCarbonCloudAdminByIdPut

Request

PUT /api/CarbonCloudAdmin/{id}

Parameters

Name	Type	Default	Notes
*id
obj	CarbonCloudPackageDTO

Responses

Status Code	Type	Description	Samples
400	object	Bad Request
404		Not Found
200	CarbonCloudPackageDTO	Success

ApiCarbonCloudAdminByIdPost

Request

POST /api/CarbonCloudAdmin/{id}

Parameters

Name	Type	Default	Notes
*id
CreatedDate
IsActive
*Version
Changes
PackageBlobFileName
PackageBlobAbsoluteUri
*carbonCloudPackage			The file to upload.

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
201	CarbonCloudPackageVersionDTO	Success

ApiCarbonCloudAdminByIdByVersionGet

Request

GET /api/CarbonCloudAdmin/{id}/{version}

Parameters

Name	Type	Default	Notes
*id
*version

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CarbonCloudPackageVersionDTO	Success

ApiCarbonCloudAdminByIdByVersionDownloadGet

Request

GET /api/CarbonCloudAdmin/{id}/{version}/download

Parameters

Name	Type	Default	Notes
*id
*version

Responses

Status Code	Type	Description	Samples
404		Not Found
302		Redirect

ExportFile

ApiIntegrationHubByIdExportFileGet

Request

GET /api/IntegrationHub/{id}/ExportFile[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
200	ExportOperationConfiguration[]	Success
404		Not Found

ApiIntegrationHubByIdExportFileByModuleIdActivatePost

Request

POST /api/IntegrationHub/{id}/ExportFile/{moduleId}/Activate[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

ApiIntegrationHubByIdExportFileByModuleIdDeactivatePost

Request

POST /api/IntegrationHub/{id}/ExportFile/{moduleId}/Deactivate[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

ApiIntegrationHubByIdExportFileByModuleIdPut

Request

PUT /api/IntegrationHub/{id}/ExportFile/{moduleId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId
newSettings	ExportOperationConfiguration

Responses

Status Code	Type	Description	Samples
200	ExportOperationConfiguration	Success
400	object	Bad Request
404		Not Found

ApiIntegrationHubByIdExportFileByModuleIdDelete

Request

DELETE /api/IntegrationHub/{id}/ExportFile/{moduleId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
400	object	Bad Request
404		Not Found

FinanceHub

ApiFinanceHubGet

Request

GET /api/FinanceHub[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	BasicFinanceHubModel[]	Success

ApiFinanceHubByIdGet

Request

GET /api/FinanceHub/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	FinanceHubModel	Success

FinancialPeriod

ApiFinanceHubByIdFinancialPeriodGet

Request

GET /api/FinanceHub/{id}/FinancialPeriod[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	FinancialPeriodModel[]	Success

ApiFinanceHubByIdFinancialPeriodByStartDateStringPut

Request

PUT /api/FinanceHub/{id}/FinancialPeriod/{startDateString}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*startDateString
tenantId
newSettings	FinancialPeriodModel

Responses

Status Code	Type	Description	Samples
200	FinancialPeriodModel	Success
400	object	Bad Request
404		Not Found

ApiFinanceHubByIdFinancialPeriodByStartDateStringDelete

Request

DELETE /api/FinanceHub/{id}/FinancialPeriod/{startDateString}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*startDateString
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

Global

ApiGlobalPublicSettingsGet

Request

GET /api/Global/PublicSettings

Responses

Status Code	Type	Description	Samples
200	GlobalSettingsModel	Success

GlobalAdmin

ApiGlobalAdminO365ConnectorGet

Request

GET /api/GlobalAdmin/O365Connector

Responses

Status Code	Type	Description	Samples
200	FeatureGlobalO365ConnectorDTO	Success

ApiGlobalAdminO365ConnectorPut

Request

PUT /api/GlobalAdmin/O365Connector

Parameters

Name	Type	Default	Notes
obj	FeatureGlobalO365ConnectorDTO

Responses

Status Code	Type	Description	Samples
400	object	Bad Request
200	FeatureGlobalO365ConnectorDTO	Success

ApiGlobalAdminReportingHubStatusGet

Request

GET /api/GlobalAdmin/ReportingHubStatus

Responses

Status Code	Type	Description	Samples
200	SiteCollectionStatusModel[]	Success

ApiGlobalAdminByTenantIdByFunctionPost

Request

POST /api/GlobalAdmin/{tenantId}/{function}

Parameters

Name	Type	Default	Notes
*tenantId
*function
newValue	ChangeFunctionModel

Responses

Status Code	Type	Description	Samples
200	ChangeFunctionModel	Success
400	object	Bad Request

ApiGlobalAdminByTenantIdBySiteCollectionIdByFunctionPost

Request

POST /api/GlobalAdmin/{tenantId}/{siteCollectionId}/{function}

Parameters

Name	Type	Default	Notes
*tenantId
*siteCollectionId
*function
newValue	ChangeFunctionModel

Responses

Status Code	Type	Description	Samples
200	ChangeFunctionModel	Success
400	object	Bad Request

ApiGlobalAdminPartnerCustomerAssociationStatusGet

Request

GET /api/GlobalAdmin/PartnerCustomerAssociationStatus

Responses

Status Code	Type	Description	Samples
200	PartnerAssociationStatusModel[]	Success

ApiGlobalAdminPartnerCustomerAssociationStatusPost

Request

POST /api/GlobalAdmin/PartnerCustomerAssociationStatus

Parameters

Name	Type	Default	Notes
obj	UpdatePartnerAssociationStatusModel[]

Responses

Status Code	Type	Description	Samples
403		Forbidden
400	object	Bad Request
409		Conflict
202	PartnerAssociationStatusModel[]	Success

ApiGlobalAdminPartnerStatusGet

Request

GET /api/GlobalAdmin/PartnerStatus

Responses

Status Code	Type	Description	Samples
200	PartnerModel[]	Success

ApiGlobalAdminDataPumpJobStatusGet

Request

GET /api/GlobalAdmin/DataPumpJobStatus

Responses

Status Code	Type	Description	Samples
200	DataPumpJobStatusModel	Success

ImportFile

ApiIntegrationHubByIdImportFileGet

Request

GET /api/IntegrationHub/{id}/ImportFile[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
200	ImportOperationConfiguration[]	Success
404		Not Found

ApiIntegrationHubByIdImportFileByModuleIdActivatePost

Request

POST /api/IntegrationHub/{id}/ImportFile/{moduleId}/Activate[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

ApiIntegrationHubByIdImportFileByModuleIdDeactivatePost

Request

POST /api/IntegrationHub/{id}/ImportFile/{moduleId}/Deactivate[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
404		Not Found

ApiIntegrationHubByIdImportFileByModuleIdPut

Request

PUT /api/IntegrationHub/{id}/ImportFile/{moduleId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId
newSettings	ImportOperationConfiguration

Responses

Status Code	Type	Description	Samples
200	ImportOperationConfiguration	Success
400	object	Bad Request
404		Not Found

ApiIntegrationHubByIdImportFileByModuleIdDelete

Request

DELETE /api/IntegrationHub/{id}/ImportFile/{moduleId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*moduleId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
400	object	Bad Request
404		Not Found

IntegrationHub

ApiIntegrationHubGet

Request

GET /api/IntegrationHub[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	BasicIntegrationHubModel[]	Success

ApiIntegrationHubByIdGet

Request

GET /api/IntegrationHub/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	IntegrationHubModel	Success

ItemAttribute

ApiFinanceHubByIdItemAttributeGet

Request

GET /api/FinanceHub/{id}/ItemAttribute[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
200	FinanceGridSettingsAttribute[]	Success
404		Not Found

ApiFinanceHubByIdItemAttributeByAttributeIdPut

Request

PUT /api/FinanceHub/{id}/ItemAttribute/{attributeId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*attributeId
tenantId
newSettings	FinanceGridSettingsAttribute

Responses

Status Code	Type	Description	Samples
200	FinanceGridSettingsAttribute	Success
400	object	Bad Request
404		Not Found

ApiFinanceHubByIdItemAttributeByAttributeIdDelete

Request

DELETE /api/FinanceHub/{id}/ItemAttribute/{attributeId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*attributeId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
400	object	Bad Request
404		Not Found

ItemConfiguration

ApiFinanceHubByIdItemConfigurationGet

Request

GET /api/FinanceHub/{id}/ItemConfiguration[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
200	FinanceGridSettingsMeasurement[]	Success
404		Not Found

ApiFinanceHubByIdItemConfigurationByMeasureIdPut

Request

PUT /api/FinanceHub/{id}/ItemConfiguration/{measureId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*measureId
tenantId
newSettings	FinanceGridSettingsMeasurement

Responses

Status Code	Type	Description	Samples
200	FinanceGridSettingsMeasurement	Success
400	object	Bad Request
404		Not Found

ApiFinanceHubByIdItemConfigurationByMeasureIdDelete

Request

DELETE /api/FinanceHub/{id}/ItemConfiguration/{measureId}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
*measureId
tenantId

Responses

Status Code	Type	Description	Samples
200		Success
400	object	Bad Request
404		Not Found

MultiSiteCollection

ApiMultiSiteCollectionBySiteCollectionIdGet

Request

GET /api/MultiSiteCollection/{siteCollectionId}[?tenantId]

Parameters

Name	Type	Default	Notes
*siteCollectionId
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	SiteCollectionLinkModel[]	Success

ApiMultiSiteCollectionBySiteCollectionIdPut

Request

PUT /api/MultiSiteCollection/{siteCollectionId}[?tenantId]

Parameters

Name	Type	Default	Notes
*siteCollectionId
tenantId
linkedSiteCollections	array

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
200	SiteCollectionLinkModel[]	Success

PartnerTenant

ApiPartnerTenantGet

Request

GET /api/PartnerTenant

Responses

Status Code	Type	Description	Samples
200	BasicPartnerTenantModel[]	Success

ApiPartnerTenantPost

Request

POST /api/PartnerTenant

Parameters

Name	Type	Default	Notes
obj	CreatePartnerTenantModel

Responses

Status Code	Type	Description	Samples
403		Forbidden
400	object	Bad Request
409		Conflict
201	BasicPartnerTenantModel	Success

ApiPartnerTenantByIdGet

Request

GET /api/PartnerTenant/{id}

Parameters

Name	Type	Default	Notes
*id

Responses

Status Code	Type	Description	Samples
404		Not Found
200	BasicPartnerTenantModel	Success

Region

ApiRegionGet

Request

GET /api/Region[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	RegionModel[]	Success

ReportingHub

ApiReportingHubGet

Request

GET /api/ReportingHub[?tenantId]

Parameters

Name	Type	Default	Notes
tenantId

Responses

Status Code	Type	Description	Samples
200	BasicReportingHubModel[]	Success

ApiReportingHubPost

Request

POST /api/ReportingHub[?tenantId]

Parameters

Name	Type	Default	Notes
obj	CreateReportingHubModel
tenantId

Responses

Status Code	Type	Description	Samples
403		Forbidden
400	object	Bad Request
409	ReportingHubModel	Conflict
201	ReportingHubModel	Success

ApiReportingHubByIdGet

Request

GET /api/ReportingHub/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	ReportingHubModel	Success

ApiReportingHubOAuthGet

Request

GET /api/ReportingHub/OAuth[?siteCollectionUrl&region]

Parameters

Name	Type	Default	Notes
siteCollectionUrl
region

Responses

Status Code	Type	Description	Samples
400		Bad Request
302		Redirect

ApiReportingHubByIdOAuthGet

Request

GET /api/ReportingHub/{id}/OAuth[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400		Bad Request
302		Redirect

ApiReportingHubByIdOAuthRetrustGet

Request

GET /api/ReportingHub/{id}/OAuthRetrust[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400		Bad Request
302		Redirect

ApiReportingHubOAuthRetrustGet

Request

GET /api/ReportingHub/OAuthRetrust[?siteCollectionUrl&region]

Parameters

Name	Type	Default	Notes
siteCollectionUrl
region

Responses

Status Code	Type	Description	Samples
400		Bad Request
302		Redirect

ApiReportingHubOAuthReportGet

Request

GET /api/ReportingHub/OAuthReport[?siteCollectionUrl&region]

Parameters

Name	Type	Default	Notes
siteCollectionUrl
region

Responses

Status Code	Type	Description	Samples
400		Bad Request
302		Redirect

ApiReportingHubByIdOAuthReportGet

Request

GET /api/ReportingHub/{id}/OAuthReport[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400		Bad Request
302		Redirect

ApiReportingHubByIdAuthenticationPut

Request

PUT /api/ReportingHub/{id}/Authentication[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId
obj	CreateReportingHubModel

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
200	ReportingHubModel	Success

ApiReportingHubByIdReportDesignerPost

Request

POST /api/ReportingHub/{id}/ReportDesigner[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	CreatedReportDesignerModel	Success

ApiReportingHubByIdForceRefreshPost

Request

POST /api/ReportingHub/{id}/ForceRefresh[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200		Success

ReportingHubFirewall

ApiReportingHubFirewallByIdGet

Request

GET /api/ReportingHubFirewall/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	FirewallRuleModel[]	Success

ApiReportingHubFirewallByIdPost

Request

POST /api/ReportingHubFirewall/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
obj	FirewallRuleModel
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
200	FirewallRuleModel	Success

ApiReportingHubFirewallByIdByKeyPut

Request

PUT /api/ReportingHubFirewall/{id}/{key}[?tenantId]

Parameters

Name	Type	Default	Notes
obj	FirewallRuleModel
*key
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
200	FirewallRuleModel	Success

ApiReportingHubFirewallByIdByKeyDelete

Request

DELETE /api/ReportingHubFirewall/{id}/{key}[?tenantId]

Parameters

Name	Type	Default	Notes
*key
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200		Success

Test

ApiTestCSRF_TestPost

Request

POST /api/Test/CSRF_Test

Responses

Status Code	Type	Description	Samples
200	string	Success

ApiTestTenantGet

Request

GET /api/Test/Tenant

Responses

Status Code	Type	Description	Samples
200	TenantEntity[]	Success

ApiTestTenantByTenantIdGet

Request

GET /api/Test/Tenant/{tenantId}

Parameters

Name	Type	Default	Notes
*tenantId

Responses

Status Code	Type	Description	Samples
200	TenantEntity	Success

ApiTestTenantByTenantIdGlobalGet

Request

GET /api/Test/Tenant/{tenantId}/Global

Parameters

Name	Type	Default	Notes
*tenantId

Responses

Status Code	Type	Description	Samples
200	TenantGlobalEntity	Success

ApiTestTenantByTenantIdUserGet

Request

GET /api/Test/Tenant/{tenantId}/User

Parameters

Name	Type	Default	Notes
*tenantId

Responses

Status Code	Type	Description	Samples
200	UserEntity[]	Success

ApiTestTenantByTenantIdUserByUserIdGet

Request

GET /api/Test/Tenant/{tenantId}/User/{userId}

Parameters

Name	Type	Default	Notes
*tenantId
*userId

Responses

Status Code	Type	Description	Samples
200	UserEntity	Success

UserPermission

ApiUserPermissionByIdGet

Request

GET /api/UserPermission/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
200	UserPermissionModel[]	Success

ApiUserPermissionByIdPost

Request

POST /api/UserPermission/{id}[?tenantId]

Parameters

Name	Type	Default	Notes
obj	UserPermissionModel
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
400	object	Bad Request
200	UserPermissionModel	Success

ApiUserPermissionByIdByKeyDelete

Request

DELETE /api/UserPermission/{id}/{key}[?tenantId]

Parameters

Name	Type	Default	Notes
*key
*id
tenantId

Responses

Status Code	Type	Description	Samples
404		Not Found
500		Server Error
200		Success

Definitions

UserInformation

Name	Type	Notes
isAuthenticated	boolean
tenantId	string (uuid)
userId	string (uuid)
displayName	string
surName	string
givenName	string
email	string
userName	string
activeFunctions	array
xsrftoken	string

AzureStorageModel

Name	Type	Notes
containerName	string
containerUrl	string
publicAccess	string
sharedAccessPolicies	object
knownSASToken	IntegrationContainerEntity[]

IntegrationContainerEntity

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
usage	string
policyName	string
containerUrl	string
containerName	string
ipAddressOrRange	string
ipAddressMinimum	string
ipAddressMaximum	string
createdById	string (uuid)
createdByTenantId	string (uuid)
createdByObjectId	string
createdByDisplayName	string
createdByGivenName	string
createdBySurName	string
createdByEmail	string
created	string (date-time)
partitionKey	string
rowKey	string
timestamp	string (date-time)
eTag	string

AzureStorageSASTokenModel

Name	Type	Notes
expiryTime	string (date-time)
sharedAccessSignature	string
sasTokenStorage	IntegrationContainerEntity[]

CreateSASTokenModel

Name	Type	Notes
ipAddressMinimum	string
ipAddressMaximum	string

BasicCarbonCloudModel

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

CarbonCloudModel

Name	Type	Notes
region	string
operations	BasicCarbonCloudOperationModel[]
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

BasicCarbonCloudOperationModel

Name	Type	Notes
operationId	string (uuid)
isActive	boolean
createdDate	string (date-time)
carbonCloudPackageId	string (uuid)
carbonCloudPackageTitle	string
carbonCloudPackageVersion	string

CreateCarbonCloudOperationModel

Name	Type	Notes
carbonCloudPackageId	string (uuid)
carbonCloudPackageVersion	string

CarbonCloudOperationModel

Name	Type	Notes
logBlobDownloadLink	string
operationResponse	OperationResponseDTO[]
operationId	string (uuid)
isActive	boolean
createdDate	string (date-time)
carbonCloudPackageId	string (uuid)
carbonCloudPackageTitle	string
carbonCloudPackageVersion	string

OperationResponseDTO

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
userId	string (uuid)
operationIdentfier	string (uuid)
state	string
exceptionMessage	string
timestamp	string (date-time)

CarbonCloudPackageModel

Name	Type	Notes
carbonCloudPackageId	string (uuid)
isActive	boolean
title	string
shortDescription	string
longDescription	string
changeLog	string
lastVersion	CarbonCloudPackageVersionModel

CarbonCloudPackageVersionModel

Name	Type	Notes
createdDate	string (date-time)
isActive	boolean
version	string
changes	string

CarbonCloudPackageDTO

Name	Type	Notes
carbonCloudPackageId	string (uuid)
isActive	boolean
title	string
shortDescription	string
longDescription	string
changeLog	string
versions	CarbonCloudPackageVersionDTO[]

CarbonCloudPackageVersionDTO

Name	Type	Notes
createdDate	string (date-time)
isActive	boolean
version	string
changes	string
packageBlobFileName	string
packageBlobAbsoluteUri	string

ExportOperationConfiguration

Name	Type	Notes
trigger	string
triggerConfiguration	ExportTriggerConfiguration
sqlSourceOperation	string
sqlSourceOperation_SqlCommandText	string
sqlPreExportOperation	string
sqlPostExportOperation	string
target	string
targetConfiguration	ExportTargetConfiguration
id	string (uuid)
name	string
isActive	boolean
sqlErrorOperation	string

ExportTriggerConfiguration

ExportTargetConfiguration

BasicFinanceHubModel

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

FinanceHubModel

Name	Type	Notes
primaryAdminUPN	string
siteCollectionName	string
timeZoneBias	integer (int32)
siteCollectionMaintenanceTime	string
region	string
regionTitle	string
databaseServerServerName	string
databaseServerFQDNServerName	string
databaseServerDatabaseName	string
featureReportingHub	boolean
featureCarbonCloud	boolean
featureImport	boolean
featureImportV2	boolean
featureJira	boolean
featureReportingHubSSRS	boolean
featureReportingHubPowerBIEmbedded	boolean
featureIntegration	boolean
featureFinanceHub	boolean
operationPermissions	array
fhConfig	FinanceGridSettings[]
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

FinanceGridSettings

Name	Type	Notes
measurements	FinanceGridSettingsMeasurement[]
dataStructures	FinanceGridSettingsDataStructure[]
views	FinanceGridSettingsView[]
attributes	FinanceGridSettingsAttribute[]

FinanceGridSettingsMeasurement

Name	Type	Notes
measurementId	string
title	string
readOnlySetting	string
type	string
active	boolean

FinanceGridSettingsDataStructure

Name	Type	Notes
dataStructureId	string
defaultReadOnly	boolean
memoryDataAccess	string
sqlCommand	string

FinanceGridSettingsView

Name	Type	Notes
viewId	string
title	string
measurement	FinanceGridSettingsMeasurement[]
viewControllerClass	string
viewControllerSettings	object
dataStructure	FinanceGridSettingsDataStructure[]
visible	VisibleLogic[]
allowColumnFreeze	boolean

VisibleLogic

Name	Type	Notes
isActive	boolean
field	string
filter	string
value	array

FinanceGridSettingsAttribute

Name	Type	Notes
attributeId	string
title	string
type	string
description	string
numberDecimalPlaces	integer (int32)
choiceValues	array
active	boolean

FinancialPeriodModel

Name	Type	Notes
title	string
startDate	string (date-time)
finishDate	string (date-time)
status	string

GlobalSettingsModel

Name	Type	Notes
sharePointClientId	string
sharePointGuestAccount	string
externalUrlOfPortal	string
externalUrlOfReports	string

FeatureGlobalO365ConnectorDTO

Name	Type	Notes
eTag	string
isActive	boolean
title	string
o365WebhookUrl	string

SiteCollectionStatusModel

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
created	string (date-time)
region	string
siteCollectionUrl	string
tenantPrimaryAdminUPN	string
partnerTenantId	string (uuid)
tenantDomains	array
tenantUnlockedFunctions	array
featureReportingHub	boolean
featureReportingHubSSRS	boolean
featureReportingHubPowerBIEmbedded	boolean
featureReportingHubDeployWebPart	boolean
featureCarbonCloud	boolean
featureImport	boolean
featureImportV2	boolean
featureIntegration	boolean
featureFinanceHub	boolean
dataPumpLastAuthError	string (date-time)
dataPumpLastAdminQueueError	string (date-time)
dataPumpDeactivateQueueUntil	string (date-time)
dataPumpDeactivateQueueReason	string
dataPumpLastFullSyncQueued	string (date-time)
dataPumpLastFullSyncOperationId	string (uuid)
dataPumpLastFullSyncStatusTimestamp	string (date-time)
dataPumpLastFullSyncStatusInt	integer (int32)
dataPumpLastFullSyncError	string
dataPumpLastMaintenanceQueued	string (date-time)
dataPumpLastMaintenanceOperationId	string (uuid)
dataPumpLastMaintenanceStatusTimestamp	string (date-time)
dataPumpLastMaintenanceStatusInt	integer (int32)
dataPumpLastMaintenanceError	string
dataPumpLastHourlyMaintenanceQueued	string (date-time)
dataPumpLastHourlyMaintenanceOperationId	string (uuid)
dataPumpLastHourlyMaintenanceStatusTimestamp	string (date-time)
dataPumpLastHourlyMaintenanceStatusInt	integer (int32)
dataPumpLastHourlyMaintenanceError	string
dataPumpLastIndexOptimizeQueued	string (date-time)
dataPumpLastIndexOptimizeOperationId	string (uuid)
dataPumpLastIndexOptimizeStatusTimestamp	string (date-time)
dataPumpLastIndexOptimizeStatusInt	integer (int32)
dataPumpLastIndexOptimizeError	string
dataPumpWebPartDeployedVersion	string
dataPumpWebPartDeployedTimestamp	string (date-time)
dataPumpDatabaseVersion	string
dataPumpDatabaseTimestamp	string (date-time)

ChangeFunctionModel

Name	Type	Notes
targetValue	boolean

PartnerAssociationStatusModel

Name	Type	Notes
tenantId	string (uuid)
tenantName	string
created	string (date-time)
primaryAdminUPN	string
region	string
unlockedFunctions	TenantUnlockedFunctionModel[]
partner	TenantPartnerModel
tenantDomains	array
pwaSiteCollections	TenantPWASiteCollectionModel[]

TenantUnlockedFunctionModel

Name	Type	Notes
name	string
isUnlocked	boolean
unlockedByTenantId	string (uuid)
unlockedByUserId	string (uuid)
unlockedOn	string (date-time)

TenantPartnerModel

Name	Type	Notes
isActive	boolean
targetTenantId	string (uuid)
activatedByTenantId	string (uuid)
activatedByUserId	string (uuid)
activatedOn	string (date-time)

TenantPWASiteCollectionModel

Name	Type	Notes
isActive	boolean
siteCollectionId	string (uuid)
siteCollectionUrl	string
createdByTenantId	string (uuid)
createdByUserId	string (uuid)
createdOn	string (date-time)

UpdatePartnerAssociationStatusModel

Name	Type	Notes
tenantId	string (uuid)
tenantPrimaryAdminUPN	string
partnerId	string (uuid)

PartnerModel

Name	Type	Notes
partnerId	string (uuid)
partnerName	string

DataPumpJobStatusModel

Name	Type	Notes
region	object
dataPumpJob	DataPumpJobEntryStatusModel[]

DataPumpJobEntryStatusModel

Name	Type	Notes
region	string
partitionKey	string
rowKey	string
timestamp	string (date-time)

ImportOperationConfiguration

Name	Type	Notes
trigger	string
triggerConfiguration	ImportTriggerConfiguration
sqlTargetTable	SqlTableConfiguration
sqlTargetTableOperation	string
sqlTargetTableOperation_SqlCommandText	string
sqlPreImportOperation	string
sqlPreCopyOperation	string
sqlPostCopyOperation	string
id	string (uuid)
name	string
isActive	boolean
sqlErrorOperation	string

ImportTriggerConfiguration

SqlTableConfiguration

Name	Type	Notes
tableName	string
tableFields	SqlFieldConfiguration[]

SqlFieldConfiguration

Name	Type	Notes
fieldName	string
fieldType	string
fieldLength	integer (int32)
fieldPrecision	integer (int32)
fieldScale	integer (int32)
fieldParserFormat	string
isNullable	boolean
isPrimaryKey	boolean

BasicIntegrationHubModel

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

IntegrationHubModel

Name	Type	Notes
primaryAdminUPN	string
siteCollectionName	string
timeZoneBias	integer (int32)
siteCollectionMaintenanceTime	string
region	string
regionTitle	string
databaseServerServerName	string
databaseServerFQDNServerName	string
databaseServerDatabaseName	string
featureReportingHub	boolean
featureCarbonCloud	boolean
featureImport	boolean
featureImportV2	boolean
featureJira	boolean
featureReportingHubSSRS	boolean
featureReportingHubPowerBIEmbedded	boolean
featureIntegration	boolean
operationPermissions	array
importV1	ImportConfiguration[]
integrationExportSharePoint	ExportOperationConfiguration[]
integrationExportFile	BasicModuleInfo[]
integrationImportFile	BasicModuleInfo[]
importV2	SQLPackageDetail[]
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string

ImportConfiguration

Name	Type	Notes
importSchedules	ScheduleConfiguration[]

ScheduleConfiguration

Name	Type	Notes
isActive	boolean
frequencyUnit	string
status	string
progress	integer (int32)
frequency	integer (int32)
cronTriggerExpression	string
nextStartDate	string (date-time)
errorAction	string
processingEffort	integer (int32)
importPackages	PackageConfiguration[]

PackageConfiguration

Name	Type	Notes
title	string
mappingDataSource	MappingDataSource[]
dataSourceFilter	string
testMode	boolean
priority	integer (int32)
monitorQueue	string
importSettings	MappingEntity[]

MappingDataSource

Name	Type	Notes
commandText	string
commandType	string

MappingEntity

Name	Type	Notes
importPackageVersion	integer (int32)
targetEntityType	string
importAction	string
errorAction	string
clearPreviousLogEntries	boolean
entityCheckedOutAction	string
entityParentMissingAction	string
includeVisibilityModeProjects	boolean
publishEntityChanges	boolean
taskParentField	string
taskParentFieldEmptyValue	string
autoApproveStatusUpdate	boolean
lookupSourceTreeDelimiter	string
resourceRateOverwriteAllResourceRates	boolean
resourceRateOverwriteResourceRatesFromFirstImportedRate	boolean
projectMatching	MappingEntityMatch[]
taskMatching	MappingEntityMatch[]
resourceMatching	MappingEntityMatch[]
resourceRateEffectiveDateMatching	MappingEntityMatch[]
resourceRateTableMatching	MappingEntityMatch[]
assignmentStartMatching	MappingEntityMatch[]
assignmentFinishMatching	MappingEntityMatch[]
lookupTableNameMatching	MappingEntityMatch[]
lookupTableValueMatching	MappingEntityMatch[]
mappingFields	MappingField[]

MappingEntityMatch

Name	Type	Notes
targetFieldName	string
sourceFieldName	string
entityMatch	string

MappingField

Name	Type	Notes
targetFieldName	string
sourceFieldName	string
conversionRule	string
lookupTableTreeValueDelimiter	string

BasicModuleInfo

Name	Type	Notes
id	string (uuid)
name	string
isActive	boolean

SQLPackageDetail

Name	Type	Notes
sqlSchemaName	string
sqlObjectName	string
sqlObjectType	string
target	string
title	string
frequency	string
sqlObjectCreated	string (date-time)
sqlObjectModified	string (date-time)
sqlCommandText	string
sqlCommandType	string
peiTargetType	string

SiteCollectionLinkModel

Name	Type	Notes
siteCollectionId	string (uuid)
name	string
url	string
linkApplied	boolean
status	string

BasicPartnerTenantModel

Name	Type	Notes
tenantId	string (uuid)
tenantPrimaryAdminUPN	string
isActive	boolean
created	string (date-time)
tenantDomains	array
functions	array

CreatePartnerTenantModel

Name	Type	Notes
sharePointServiceUrl	string
functions	array
region	string
tenantPrimaryAdminUPN	string

RegionModel

Name	Type	Notes
regionKey	string
regionName	string

BasicReportingHubModel

Name	Type	Notes
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string
status	string

CreateReportingHubModel

Name	Type	Notes
region	string
o365AuthenticationMethod	string
o365AuthenticationUserName	string
o365AuthenticationPassword	string
o365AuthenticationOAuthToken	string
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string
status	string

ReportingHubModel

Name	Type	Notes
primaryAdminUPN	string
siteCollectionName	string
timeZoneBias	integer (int32)
siteCollectionMaintenanceTime	string
region	string
regionTitle	string
o365AuthenticationMethod	string
o365AuthenticationUserName	string
databaseServerServerName	string
databaseServerFQDNServerName	string
databaseServerDatabaseName	string
featureReportingHub	boolean
featureCarbonCloud	boolean
featureImport	boolean
featureImportV2	boolean
featureFinanceHub	boolean
featureJira	boolean
featureReportingHubSSRS	boolean
featureReportingHubPowerBIEmbedded	boolean
featureIntegration	boolean
tenantSharePointAdminUrl	string
secureStoreId	string
secureStoreUsername	string
secureStorePassword	string
operationPermissions	array
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string
status	string

CreatedReportDesignerModel

Name	Type	Notes
databaseServerServerName	string
databaseServerFQDNServerName	string
databaseServerDatabaseName	string
ipAddressOfClient	string
reportDesignerUsername	string
reportDesignerPassword	string
connectionString	string
tenantId	string (uuid)
siteCollectionId	string (uuid)
siteCollectionUrl	string
status	string

FirewallRuleModel

Name	Type	Notes
key	string
name	string
startIPAddress	string
endIPAddress	string
create	string (date-time)
modify	string (date-time)
createdById	string (uuid)
createdByTenantId	string (uuid)
createdByObjectId	string
createdByDisplayName	string
createdByGivenName	string
createdBySurName	string
createdByEmail	string

TenantEntity

Name	Type	Notes
id	string (uuid)
issuerValue	string
concurrencyStamp	string
created	string (date-time)
adminConsent	boolean
adminConsentDate	string (date-time)
tenantDomains	array
serilizedJson	string
partitionKey	string
rowKey	string
timestamp	string (date-time)
eTag	string

TenantGlobalEntity

Name	Type	Notes
tenantId	string (uuid)
created	string (date-time)
primaryAdminUPN	string
region	string
serilizedJson	string
unlockedFunctions	TenantUnlockedFunctions[]
func	string
partner	TenantPartner[]
part	string
pwaSiteCollections	TenantPWASiteCollection[]
pwa	string
partitionKey	string
rowKey	string
timestamp	string (date-time)
eTag	string

TenantUnlockedFunctions

Name	Type	Notes
name	string
act	boolean
IsUnlocked	boolean
byTen	string (uuid)
UnlockedByTenantId	string (uuid)
byUsr	string (uuid)
UnlockedByUserId	string (uuid)
on	string (date-time)
UnlockedOn	string (date-time)
key	string
UnlockTokenKey	string

TenantPartner

Name	Type	Notes
act	boolean
IsActive	boolean
Ten	string (uuid)
TargetTenantId	string (uuid)
byTen	string (uuid)
ActivatedByTenantId	string (uuid)
byUsr	string (uuid)
ActivatedByUserId	string (uuid)
on	string (date-time)
ActivatedOn	string (date-time)
key	string
UnlockTokenKey	string

TenantPWASiteCollection

Name	Type	Notes
act	boolean
IsActive	boolean
id	string (uuid)
SiteCollectionId	string (uuid)
url	string
SiteCollectionUrl	string
byTen	string (uuid)
CreatedByTenantId	string (uuid)
byUsr	string (uuid)
CreatedByUserId	string (uuid)
on	string (date-time)
CreatedOn	string (date-time)

UserEntity

Name	Type	Notes
id	string (uuid)
tenantId	string (uuid)
objectId	string (uuid)
displayName	string
givenName	string
surName	string
email	string
concurrencyStamp	string
created	string (date-time)
partitionKey	string
rowKey	string
timestamp	string (date-time)
eTag	string

UserPermissionModel

Name	Type	Notes
key	string
userUPN	string
create	string (date-time)
modify	string (date-time)
createdById	string (uuid)
createdByTenantId	string (uuid)
createdByObjectId	string
createdByDisplayName	string
createdByGivenName	string
createdBySurName	string
createdByEmail	string
reportingHubNamedUser	boolean
reportingHubAdmin	boolean
editable	boolean
source	string