Resources APIs

Get Technology Access Categories (GET)

Reads connector configuration access categories for selected technology connector resource technology

Route

URI	/api/v1/Resources/AccessCategories
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Example

GET http://localhost/api/v1/Resources/AccessCategories

Execute Actions (POST)

See <see cref="IResourcesService.ExecuteActions"/>.

Route

URI	/api/v1/Resources/Action/{resourceTypeId}
Method	POST
Result	JSON – ChangeResult

Request Payload

ExecuteActionParameter[] object:

Property	Type	Mandatory	Description
EntryId	int	No	The ID of the grid entry.
Parameter	string[]	No
GridColumnDefinitions	GridColumnDefinition[]	No
DynamicGridColumnDefinitions	GridColumnDefinition[]	No
FormDataJson	string	No
Comment	string	No
ActionId	Guid?	No
ParameterSingleLine	object[]	No
TargetParameter	string	No
Action	string	Yes

Response Structure Returns ChangeResult object containing:

Success: bool value
Data: object value
ResponseId: Guid? value
ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/Resources/Action/{resourceTypeId} Content-Type: application/json  

{     
"EntryId": 1,     
"Parameter": {},     
"GridColumnDefinitions": {},     
"DynamicGridColumnDefinitions": {},     
"FormDataJson": "sample",     
"Comment": "sample",     
"ActionId": "123e4567-e89b-12d3-a456-426614174000",     
"ParameterSingleLine": {},     
"TargetParameter": "sample",     
"Action": "sample" 
}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Ancestors (GET)

Get ancestors for a given node by uri key

Route

URI	/api/v1/Resources/Ancestors
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceOwnerConfigurationResourceModel[] object containing:

Resource: LightResourceModel value
HasChildren: Indicates if the resource has children.
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.

Example

GET http://localhost/api/v1/Resources/Ancestors

Example Response

{     "Resource": {},     "HasChildren": true,     "HasConfigurationEntry": true,     "DescendantHasConfigurationEntry": true }

Can Resource Be Modified (POST)

Can Resource Be Modified.

Route

URI	/api/v1/Resources/CanBeModified
Method	POST
Result	JSON – int

Parameters

None

Example

POST http://localhost/api/v1/Resources/CanBeModified

Get Children (GET)

Get children for a given node by uri key

Route

URI	/api/v1/Resources/Children
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceTreeItemModel[] object containing:

Id: uri Key
Name: display name
TypeId: typeIdfor icon
ResourceType: resourceType for icon, if applicable
Path: displayPath
NextReview: if applicable
Size: if applicable
DirectChildCount: int value
UsersHaveAccess: int value
GroupsHaveAccess: int value
DataOwners: ResourceOwnerConfigurationModel[] value
SidAccountId: SidAccountId (ResourceKey)
ResourceKeyValue: Value of ResourceKey
AlertDefinitionIds: Alert Definition Id

Example

GET http://localhost/api/v1/Resources/Children

Example Response

{     
"Id": "sample",     
"Name": "sample",     
"TypeId": 1,     
"ResourceType": {},     
"Path": "sample",     
"NextReview": "2026-01-15T10:30:00Z",     
"Size": 1,     
"DirectChildCount": 1,     
"UsersHaveAccess": 1,     
"GroupsHaveAccess": 1,     
"DataOwners": {},     
"SidAccountId": "sample",     
"ResourceKeyValue": {},     
"AlertDefinitionIds": {} 
}

Get Data Owners Of Resource (GET)

Get DataOwners for a given resource by uri key

Route

URI	/api/v1/Resources/Dataowner/Resource
Method	GET
Result	JSON – AccountModel[]

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns AccountModel[] object containing:

ResourceTypeGuid: Guid value
SerializedAccountId: string value
UriKey: string value
DisplayName: string value
Provider: TechnologyProvider value
IsGroup: bool value
Sid: string value
Guid: Guid? value
Description: string value
Attributes: KeyValuePair<string, string>[] value
ExtendedAttributes: KeyValuePair<string, string>[] value
Children: string[] value
TypeId: int value

Example

GET http://localhost/api/v1/Resources/Dataowner/Resource

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }

Add Data Owner To Resource (POST)

Adds data owners (<paramref name="accountsWithUri"/>) to the specified resource node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Resource/add
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Parameters

Name	Type	Mandatory	Description
accountsWithUri	AccountsWithUriKey	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

DataOwners: AccountModel[] value
ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Resource/add

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Remove Data Owner From Resource (POST)

Removes data owners (<paramref name="accountsWithUriKey"/>) to the specified resource node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Resource/delete
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Parameters

Name	Type	Mandatory	Description
accountsWithUriKey	AccountsWithUriKey	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

DataOwners: AccountModel[] value
ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Resource/delete

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Get Data Owners Of Resource Is Enabled (GET)

Determine if DataOwners of resources are enabled

Route

URI	/api/v1/Resources/Dataowner/Resource/IsEnabled
Method	GET
Result	JSON – bool

Parameters

None

Example

GET http://localhost/api/v1/Resources/Dataowner/Resource/IsEnabled

Get Data Owners Of Root (GET)

Get DataOwners of root node

Route

URI	/api/v1/Resources/Dataowner/Root
Method	GET
Result	JSON – AccountModel[]

Parameters

None

Response Structure Returns AccountModel[] object containing:

ResourceTypeGuid: Guid value
SerializedAccountId: string value
UriKey: string value
DisplayName: string value
Provider: TechnologyProvider value
IsGroup: bool value
Sid: string value
Guid: Guid? value
Description: string value
Attributes: KeyValuePair<string, string>[] value
ExtendedAttributes: KeyValuePair<string, string>[] value
Children: string[] value
TypeId: int value

Example

GET http://localhost/api/v1/Resources/Dataowner/Root

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }

Add Data Owner To Root (POST)

Adds data owners (<paramref name="accounts"/>) to the root node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Root/add
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Request Payload

AccountModel[] object:

Property	Type	Mandatory
ResourceTypeGuid	Guid	Yes
SerializedAccountId	string	Yes
UriKey	string	Yes
DisplayName	string	No
Provider	TechnologyProvider	No
IsGroup	bool	No
Sid	string	No
Guid	Guid?	No
Description	string	No
Attributes	KeyValuePair<string, string>[]	No
ExtendedAttributes	KeyValuePair<string, string>[]	No
Children	string[]	No
TypeId	int	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

- DataOwners: AccountModel[] value

- ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Root/add Content-Type: application/json  

{     
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     
"SerializedAccountId": "sample",     
"UriKey": "sample",     
"DisplayName": "sample",     
"Provider": {},     
"IsGroup": true,     
"Sid": "sample",     
"Guid": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"Attributes": {},     
"ExtendedAttributes": {},     
"Children": {},     
"TypeId": 1 
}

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Remove Data Owner From Root (POST)

Removes data owners (<paramref name="accounts"/>) to the root node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Root/delete
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Request Payload

AccountModel[] object:

Property	Type	Mandatory
ResourceTypeGuid	Guid	Yes
SerializedAccountId	string	Yes
UriKey	string	Yes
DisplayName	string	No
Provider	TechnologyProvider	No
IsGroup	bool	No
Sid	string	No
Guid	Guid?	No
Description	string	No
Attributes	KeyValuePair<string, string>[]	No
ExtendedAttributes	KeyValuePair<string, string>[]	No
Children	string[]	No
TypeId	int	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

DataOwners: AccountModel[] value
ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Root/delete Content-Type: application/json  
{     
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     
"SerializedAccountId": "sample",     
"UriKey": "sample",     
"DisplayName": "sample",     
"Provider": {},     
"IsGroup": true,     
"Sid": "sample",     
"Guid": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"Attributes": {},     
"ExtendedAttributes": {},     
"Children": {},     
"TypeId": 1 
}

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Get Data Owners Of Technology (GET)

Get DataOwners for a given technology by resource type

Route

URI	/api/v1/Resources/Dataowner/Technology/{typeId}
Method	GET
Result	JSON – AccountModel[]

Parameters

Name	Type	Mandatory	Description
typeId	int	Yes

Response Structure Returns AccountModel[] object containing:

ResourceTypeGuid: Guid value
SerializedAccountId: string value
UriKey: string value
DisplayName: string value
Provider: TechnologyProvider value
IsGroup: bool value
Sid: string value
Guid: Guid? value
Description: string value
Attributes: KeyValuePair<string, string>[] value
ExtendedAttributes: KeyValuePair<string, string>[] value
Children: string[] value
TypeId: int value

Example

GET http://localhost/api/v1/Resources/Dataowner/Technology/{typeId}

Example Response

{     
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     
"SerializedAccountId": "sample",     
"UriKey": "sample",     
"DisplayName": "sample",     
"Provider": {},     
"IsGroup": true,     
"Sid": "sample",     
"Guid": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"Attributes": {},     
"ExtendedAttributes": {},     
"Children": {},     
"TypeId": 1 
}

Add Data Owner To Technology (POST)

Adds data owners (<paramref name="accounts"/>) to the specified technology node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Technology/{typeId}/add
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Request Payload

AccountModel[] object:

Property	Type	Mandatory
ResourceTypeGuid	Guid	Yes
SerializedAccountId	string	Yes
UriKey	string	Yes
DisplayName	string	No
Provider	TechnologyProvider	No
IsGroup	bool	No
Sid	string	No
Guid	Guid?	No
Description	string	No
Attributes	KeyValuePair<string, string>[]	No
ExtendedAttributes	KeyValuePair<string, string>[]	No
Children	string[]	No
TypeId	int	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

DataOwners: AccountModel[] value
ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Technology/{typeId}/add Content-Type: application/json  

{     
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     
"SerializedAccountId": "sample",     
"UriKey": "sample",     
"DisplayName": "sample",     
"Provider": {},     
"IsGroup": true,    
"Sid": "sample",     
"Guid": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"Attributes": {},     
"ExtendedAttributes": {},     
"Children": {},     
"TypeId": 1 
}

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Remove Data Owner From Technology (POST)

Removes data owners (<paramref name="accounts"/>) to the specified technology node and returns the updated (or newly created) entry.

Route

URI	/api/v1/Resources/Dataowner/Technology/{typeId}/delete
Method	POST
Result	JSON – ResourceOwnerConfigurationEntryModel

Request Payload

AccountModel[] object:

Property	Type	Mandatory
ResourceTypeGuid	Guid	Yes
SerializedAccountId	string	Yes
UriKey	string	Yes
DisplayName	string	No
Provider	TechnologyProvider	No
IsGroup	bool	No
Sid	string	No
Guid	Guid?	No
Description	string	No
Attributes	KeyValuePair<string, string>[]	No
ExtendedAttributes	KeyValuePair<string, string>[]	No
Children	string[]	No
TypeId	int	No

Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:

DataOwners: AccountModel[] value
ErrorMessages: string[] value

Example

POST http://localhost/api/v1/Resources/Dataowner/Technology/{typeId}/delete Content-Type: application/json  

{     
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     
"SerializedAccountId": "sample",     
"UriKey": "sample",     
"DisplayName": "sample",     
"Provider": {},     
"IsGroup": true,     
"Sid": "sample",     
"Guid": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"Attributes": {},     
"ExtendedAttributes": {},     
"Children": {},     
"TypeId": 1 
}

Example Response

{     "DataOwners": {},     "ErrorMessages": {} }

Get Resource Permissions (GET)

Reads permission from resource

Route

URI	/api/v1/Resources/permission
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns LightAccountPermissionCompositionModel[] object containing:

PermissionCompositionModels: LightPermissionCompositionModel[] value
Account: LightAccountModel value

Example

GET http://localhost/api/v1/Resources/permission

Example Response

{     "PermissionCompositionModels": {},     "Account": {} }

Get Resource Prevention Reason (POST)

Get Resource Prevention Reason.

Route

URI	/api/v1/Resources/PreventionReason
Method	POST
Result	JSON – List<PreventionReasonModel>

Parameters

None

Response Structure Returns List<PreventionReasonModel> object containing:

UriKey: string value
PreventionReason: uint value

Example

POST http://localhost/api/v1/Resources/PreventionReason

Example Response

{     "UriKey": "sample",     "PreventionReason": {} }

Execute Remove Account (POST)

Remove selected account from File server

Route

URI	/api/v1/Resources/RemoveAccount/{resourceTypeId}
Method	POST
Result	JSON – ChangeResult

Request Payload

RemoveAccountRequest object:

Property	Type	Mandatory
UriKeys	string[]	No
AccountIds	string[]	No
Comment	string	No

Response Structure Returns ChangeResult object containing:

Success: bool value
Data: object value
ResponseId: Guid? value
ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/Resources/RemoveAccount/{resourceTypeId} Content-Type: application/json  

{     
"UriKeys": {},     
"AccountIds": {},     
"Comment": "sample" 
}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Resource By Uri (GET)

Get resource by uri key

Route

URI	/api/v1/Resources/Resource
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceOwnerConfigurationResourceModel object containing:

Resource: LightResourceModel value
HasChildren: Indicates if the resource has children.
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.

Example

GET http://localhost/api/v1/Resources/Resource

Example Response

{     "Resource": {},     "HasChildren": true,     "HasConfigurationEntry": true,     "DescendantHasConfigurationEntry": true }

Can Resource Be Modified (GET)

Can Resource Be Modified.

Route

URI	/api/v1/Resources/Resource/CanBeModified
Method	GET
Result	JSON – int

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Example

GET http://localhost/api/v1/Resources/Resource/CanBeModified

Get Resource Details By Uri (GET)

Get resource details by uri key

Route

URI	/api/v1/Resources/Resource/Details
Method	GET
Result	JSON – ResourceTreeItemModel

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceTreeItemModel object containing:

Id: uri Key
Name: display name
TypeId: typeIdfor icon
ResourceType: resourceType for icon, if applicable
Path: displayPath
NextReview: if applicable
Size: if applicable
DirectChildCount: int value
UsersHaveAccess: int value
GroupsHaveAccess: int value
DataOwners: ResourceOwnerConfigurationModel[] value
SidAccountId: SidAccountId (ResourceKey)
ResourceKeyValue: Value of ResourceKey
AlertDefinitionIds: Alert Definition Id

Example

GET http://localhost/api/v1/Resources/Resource/Details

Example Response

{     
"Id": "sample",     
"Name": "sample",     
"TypeId": 1,     
"ResourceType": {},     
"Path": "sample",     
"NextReview": "2026-01-15T10:30:00Z",     
"Size": 1,     
"DirectChildCount": 1,     
"UsersHaveAccess": 1,     
"GroupsHaveAccess": 1,     
"DataOwners": {},     
"SidAccountId": "sample",     
"ResourceKeyValue": {},     
"AlertDefinitionIds": {} 
}

Get Supported Actions For Resource (GET)

Get Supported Actions For Resource.

Route

URI	/api/v1/Resources/Resource/SupportedActions
Method	GET
Result	JSON – ResourceActionModel

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceActionModel object containing:

UriKey: string value
SupportedActions: Guid[] value
AvailableActions: ScenarioActionDefinitionModel[] value

Example

GET http://localhost/api/v1/Resources/Resource/SupportedActions

Example Response

{     "UriKey": "sample",     "SupportedActions": {},     "AvailableActions": {} }

Get Resource Rights By Type (GET)

Get technology rights for a given ResourceType

Route

URI	/api/v1/Resources/Rights/{typeId}
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
typeId	int	Yes

Response Structure Returns AccessEntryInfo[] object containing:

Name: string value
ResourceTypes: ResourceType[] value
Properties: AccessEntryPropertyInfo[] value

Example

GET http://localhost/api/v1/Resources/Rights/{typeId}

Example Response

{     "Name": "sample",     "ResourceTypes": {},     "Properties": {} }

Get Resource Rights (GET)

Get technology rights

Route

URI	/api/v1/Resources/Rights/All
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

None

Response Structure Returns AccessEntryInfo[] object containing:

Name: string value
ResourceTypes: ResourceType[] value
Properties: AccessEntryPropertyInfo[] value

Example

GET http://localhost/api/v1/Resources/Rights/All

Example Response

{     "Name": "sample",     "ResourceTypes": {},     "Properties": {} }

Get Technology Root By Uri (GET)

Get TechnologyNode of a given resource by uri

Route

URI	/api/v1/Resources/Root
Method	GET
Result	JSON – ResourceTypeModel

Parameters

Name	Type	Mandatory	Description
uriKey	string	No

Response Structure Returns ResourceTypeModel object containing:

DisplayName: Gets or sets the localized display name.
ResourceType: ResourceType value
TypeId: Gets or sets the type ID (for displaying an icon).

Example

GET http://localhost/api/v1/Resources/Root

Example Response

{     "DisplayName": "sample",     "ResourceType": {},     "TypeId": 1 }

Get Technology Nodes (GET)

Get all TechnologyNodes directly under the root nodes

Route

URI	/api/v1/Resources/Roots
Method	GET
Result	JSON – ResourceTypeModel[]

Parameters

None

Response Structure Returns ResourceTypeModel[] object containing:

DisplayName: Gets or sets the localized display name.
ResourceType: ResourceType value
TypeId: Gets or sets the type ID (for displaying an icon).

Example

GET http://localhost/api/v1/Resources/Roots

Example Response

{     "DisplayName": "sample",     "ResourceType": {},     "TypeId": 1 }

Get Technology Roots By Type (GET)

Get technology roots for a given ResourceType

Route

URI	/api/v1/Resources/Roots/{typeId}
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
typeId	int	Yes

Response Structure Returns ResourceOwnerConfigurationResourceModel[] object containing:

Resource: LightResourceModel value
HasChildren: Indicates if the resource has children.
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.

Example

GET http://localhost/api/v1/Resources/Roots/{typeId}

Example Response

{     "Resource": {},     "HasChildren": true,     "HasConfigurationEntry": true,     "DescendantHasConfigurationEntry": true }

Get Technology Root By Type Str (GET)

Get technology roots for a given ResourceType

Route

URI	/api/v1/Resources/Roots/typeStr/{typeStr}
Method	GET
Result	JSON – ResourceOwnerConfigurationResourceModel[]

Parameters

Name	Type	Mandatory	Description
typeStr	string	Yes

Response Structure Returns ResourceTreeItemModel[] object containing:

Id: uri Key
Name: display name
TypeId: typeIdfor icon
ResourceType: resourceType for icon, if applicable
Path: displayPath
NextReview: if applicable
Size: if applicable
DirectChildCount: int value
UsersHaveAccess: int value
GroupsHaveAccess: int value
DataOwners: ResourceOwnerConfigurationModel[] value
SidAccountId: SidAccountId (ResourceKey)
ResourceKeyValue: Value of ResourceKey
AlertDefinitionIds: Alert Definition Id

Example

GET http://localhost/api/v1/Resources/Roots/typeStr/{typeStr}

Example Response

{     
"Id": "sample",     
"Name": "sample",     
"TypeId": 1,     
"ResourceType": {},     
"Path": "sample",     
"NextReview": "2026-01-15T10:30:00Z",     
"Size": 1,     
"DirectChildCount": 1,     
"UsersHaveAccess": 1,     
"GroupsHaveAccess": 1,     
"DataOwners": {},     
"SidAccountId": "sample",     
"ResourceKeyValue": {},     
"AlertDefinitionIds": {} 
}

Get Supported Actions (POST)

Get Supported Actions.

Route

URI	/api/v1/Resources/SupportedActions
Method	POST
Result	JSON – ResourceActionModel[]

Parameters

None

Response Structure Returns ResourceActionModel[] object containing:

UriKey: string value
SupportedActions: Guid[] value
AvailableActions: ScenarioActionDefinitionModel[] value

Example

POST http://localhost/api/v1/Resources/SupportedActions

Example Response

{     "UriKey": "sample",     "SupportedActions": {},     "AvailableActions": {} }

Get Resource User Info (POST)

Reads User details from resource

Route

URI	/api/v1/Resources/UserInfo
Method	POST
Result	JSON – LightAccountModel[]

Parameters

None

Response Structure Returns LightAccountPermissionCompositionModel[] object containing:

PermissionCompositionModels: LightPermissionCompositionModel[] value
Account: LightAccountModel value

Example

POST http://localhost/api/v1/Resources/UserInfo

Example Response

{     "PermissionCompositionModels": {},     "Account": {} }

Search SolarWinds Support

Resources APIs

Get Technology Access Categories (GET)

Route

Parameters

Example

Execute Actions (POST)

Route

Request Payload

Example

Example Response

Get Ancestors (GET)

Route

Parameters

Example

Example Response

Can Resource Be Modified (POST)

Route

Parameters

Example

Get Children (GET)

Route

Parameters

Example

Example Response

Get Data Owners Of Resource (GET)

Route

Parameters

Example

Example Response

Add Data Owner To Resource (POST)

Route

Parameters

Example

Example Response

Remove Data Owner From Resource (POST)

Route

Parameters

Example

Example Response

Get Data Owners Of Resource Is Enabled (GET)

Route

Parameters

Example

Get Data Owners Of Root (GET)

Route

Parameters

Example

Example Response

Add Data Owner To Root (POST)

Route

Request Payload

Example

Example Response

Remove Data Owner From Root (POST)

Route

Request Payload

Example

Example Response

Get Data Owners Of Technology (GET)

Route

Parameters

Example

Example Response

Add Data Owner To Technology (POST)

Route

Request Payload

Example

Example Response

Remove Data Owner From Technology (POST)

Route

Request Payload

Example

Example Response

Get Resource Permissions (GET)

Route

Parameters

Example

Example Response

Get Resource Prevention Reason (POST)