Documentation forAccess Rights Manager

Orders APIs

Get Orders Waiting For Count (GET)

Returns the number of orders waiting for approval by the current user.

Route

URI

/api/v1/Orders

Method

GET

Result

JSON – int

Parameters

None

Example

GET http://localhost/api/v1/Orders

Approve Order Items (POST)

Approves a set of orders.

Route

URI

/api/v1/Orders/ApproveOrderItems

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

approveOrderItemsRequest

ApproveOrderItemsRequest

No

 

Example

POST http://localhost/api/v1/Orders/ApproveOrderItems

Email Order Items (POST)

Send email to next approver for given orderItem

Route

URI

/api/v1/Orders/EmailOrderItems

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

stornOrderItemsRequest

StornOrderItemsRequest

No

 

Example

POST http://localhost/api/v1/Orders/EmailOrderItems

Get All Orders (GET)

Get All Orders.

Route

URI

/api/v1/Orders/GetAllOrders

Method

GET

Result

JSON – OrderModel[]

Parameters

None

Response Structure Returns OrderModel[] object containing:

  • MetaKey: string value

  • Requester: AccountModel value

  • Grantees: AccountModel[] value

  • RequestDateTimeString: string value

  • RequestDate: The creation date time of the order request

  • Comment: string value

  • Resources: OrderItemModel[] value

Example

GET http://localhost/api/v1/Orders/GetAllOrders

Example Response

{     "MetaKey": "sample",     "Requester": {},     "Grantees": {},     "RequestDateTimeString": "sample",     "RequestDate": "2026-01-15T10:30:00Z",     "Comment": "sample",     "Resources": {} }

Get Child Resources (POST)

Get Child Resources.

Route

URI

/api/v1/Orders/GetChildResources

Method

POST

Result

JSON – ResourceModel[]

Parameters

Name

Type

Mandatory

Description

orderableChildResourceRequest

OrderableChildResourceRequest

No

 

Response Structure Returns ResourceModel[] object containing:

  • UriKey: string value

  • ResourceType: The resource technology's primary key.

  • Name: string value

  • ResourceTypeDescription: string value

  • DisplayPath: string value

  • CategoryName: string value

  • CanBeOrdered: Indicates if the resource can be ordered. (A resource may be non-orderable even though it has children that are orderable.)

  • HasChildren: Indicates if the resource has child resources.

  • OrganizationId: The id of the organization from which the <see cref="ResourceModel"/> was ordered. If this model is an organization, then this is the organization ID itself.

  • Description: string value

  • TemplateSummary: string value

  • Properties: List<KeyValuePair<string, string>> value

  • ResourceOrderFormTemplate: IFormTemplate value

  • IsCreationalResource: Indicates whether the resource represents the creation of a new object (e.g. new account creation).

  • HasCreationalResourceChild: Indicates whether the resource has at least one child resource that is a creational resource. If true, then it is possible to browse into it even if browsing hierarchical resources is disabled in the configuration.

  • IconBase64: string value

  • IsManualInteractionRequired: bool value

  • UriKeyComparer: static IEqualityComparer<ResourceModel> value

Example

POST http://localhost/api/v1/Orders/GetChildResources

Example Response

{     
"UriKey": "sample",     
"ResourceType": {},     
"Name": "sample",     
"ResourceTypeDescription": "sample",     
"DisplayPath": "sample",     
"CategoryName": "sample",     
"CanBeOrdered": true,     
"HasChildren": true,     
"OrganizationId": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"TemplateSummary": "sample",     
"Properties": {},     
"ResourceOrderFormTemplate": {},     
"IsCreationalResource": true,     
"HasCreationalResourceChild": true,     
"IconBase64": "sample",     
"IsManualInteractionRequired": true,     
"UriKeyComparer": {} 
}

Get My Orders Count (GET)

Returns the order counts requested by the current user in the format { OrdersCount: int }.

Route

URI

/api/v1/Orders/GetMyOrdersCount

Method

GET

Result

JSON – object

Parameters

None

Example

GET http://localhost/api/v1/Orders/GetMyOrdersCount

Get Orderable Resource Parameter Unification (GET)

Computes the most general unification of a list of <see cref="IFormTemplate"/>s. If the list includes at least one template that is not a <see cref="IUnifiableFormTemplate"/>, JSON-null is returned. JSON-null is also returned if the templates are not unifiable.

Route

URI

/api/v1/Orders/GetOrderableResourceParameterUnification

Method

GET

Result

JSON – A JsonResult encoding the resulting <see cref="IUnifiableFormTemplate"/>.

Parameters

Name

Type

Mandatory

Description

templateJsonStrings

string[]

No

The <see cref="IFormTemplate"/>s, encoded as JSON strings with type information.

Example

GET http://localhost/api/v1/Orders/GetOrderableResourceParameterUnification

Get Order Preview (POST)

In the current GrantMA workflow, the  order preview (shopping cart) may show different resources than the one actually selected. This method converts the selected resource models into an order model that contains the resource models that should appear in the shopping cart.

Route

URI

/api/v1/Orders/GetOrderPreview

Method

POST

Result

JSON – OrderItemModel[]

Request Payload

OrderPreviewRequest object:

Property

Type

Mandatory

Description

ResourceModelJsonStrings

string[]

No

 

GranteesAccountModelJsonStrings

string[]

No

 

Response Structure Returns OrderItemModel[] object containing:

  • OrderItemKey: string value

  • OrderedResource: ResourceModel value

  • OrderStatus: OrderStatus value

  • OrderStatusName: The <see cref="OrderStatus"/> as localized string.

  • OrderProblemStatus: OrderProblemStatus value

  • OrderProblemStatusString: string value

  • ChangeContextId: Guid? value

  • ApproveHistory: ApproveHistoryEntry[] value

  • IsInFinalApprovalState: bool value

  • NextApprovers: string[] value

  • ShouldSelectNextApprover: Next approver must be selected from the current Approver

  • OrderItemLabel: A label for a more human being readable identification to the order item.

  • HasNotBeenUpdatedRecently: Indicates if the last time that the item was changed is more than AuthorizationConfiguration.MaxResponseTimeDays ago and the <see cref="OrderStatus"/> is <see cref="persistedObjects.OrderStatus.Open"/>.

  • FinalizationDate: DateTime? value

Example

POST http://localhost/api/v1/Orders/GetOrderPreview Content-Type: application/json  {     "ResourceModelJsonStrings": {},     "GranteesAccountModelJsonStrings": {} }

Example Response

{     "OrderItemKey": "sample",     "OrderedResource": {},     "OrderStatus": {},     "OrderStatusName": "sample",     "OrderProblemStatus": {},     "OrderProblemStatusString": "sample",     "ChangeContextId": "123e4567-e89b-12d3-a456-426614174000",     "ApproveHistory": {},     "IsInFinalApprovalState": true,     "NextApprovers": {},     "ShouldSelectNextApprover": true,     "OrderItemLabel": "sample",     "HasNotBeenUpdatedRecently": true,     "FinalizationDate": "2026-01-15T10:30:00Z" }

Get Orders Requested By (GET)

Returns the orders requested by the current user.

Route

URI

/api/v1/Orders/GetOrdersRequestedBy

Method

GET

Result

JSON – OrderModel[]

Parameters

None

Response Structure Returns OrderModel[] object containing:

  • MetaKey: string value

  • Requester: AccountModel value

  • Grantees: AccountModel[] value

  • RequestDateTimeString: string value

  • RequestDate: The creation date time of the order request

  • Comment: string value

  • Resources: OrderItemModel[] value

Example

GET http://localhost/api/v1/Orders/GetOrdersRequestedBy

Example Response

{     "MetaKey": "sample",     "Requester": {},     "Grantees": {},     "RequestDateTimeString": "sample",     "RequestDate": "2026-01-15T10:30:00Z",     "Comment": "sample",     "Resources": {} }

Get Orders Waiting For (GET)

Returns the orders waiting for approval by the current user.

Route

URI

/api/v1/Orders/GetOrdersWaitingFor

Method

GET

Result

JSON – OrderModel[]

Parameters

None

Response Structure Returns OrderModel[] object containing:

  • MetaKey: string value

  • Requester: AccountModel value

  • Grantees: AccountModel[] value

  • RequestDateTimeString: string value

  • RequestDate: The creation date time of the order request

  • Comment: string value

  • Resources: OrderItemModel[] value

Example

GET http://localhost/api/v1/Orders/GetOrdersWaitingFor

Example Response

{     
"MetaKey": "sample",     
"Requester": {},     
"Grantees": {},     
"RequestDateTimeString": "sample",     
"RequestDate": "2026-01-15T10:30:00Z",     
"Comment": "sample",     
"Resources": {} 
}

Get Orders Waiting For With Keys (GET)

Returns a JSON-encoded list of orders with the given order keys. Only orders that are waiting for approval by the user are returned.

Route

URI

/api/v1/Orders/GetOrdersWaitingForWithKeys

Method

GET

Result

JSON – OrderModel[]

Parameters

Name

Type

Mandatory

Description

orderMetaKeys

string[]

No

 

Response Structure Returns OrderModel[] object containing:

  • MetaKey: string value

  • Requester: AccountModel value

  • Grantees: AccountModel[] value

  • RequestDateTimeString: string value

  • RequestDate: The creation date time of the order request

  • Comment: string value

  • Resources: OrderItemModel[] value

Example

GET http://localhost/api/v1/Orders/GetOrdersWaitingForWithKeys

Example Response

{     
"MetaKey": "sample",     
"Requester": {},     
"Grantees": {},     
"RequestDateTimeString": "sample",     
"RequestDate": "2026-01-15T10:30:00Z",     
"Comment": "sample",     
"Resources": {} 
}

Get Root Resources Obsolete Post (POST)

Get Root Resources Obsolete Post.

Route

URI

/api/v1/Orders/GetRootResources

Method

POST

Result

JSON – ResourceModel[]

Parameters

None

Response Structure Returns ResourceModel[] object containing:

  • UriKey: string value

  • ResourceType: The resource technology's primary key.

  • Name: string value

  • ResourceTypeDescription: string value

  • DisplayPath: string value

  • CategoryName: string value

  • CanBeOrdered: Indicates if the resource can be ordered. (A resource may be non-orderable even though it has children that are orderable.)

  • HasChildren: Indicates if the resource has child resources.

  • OrganizationId: The id of the organization from which the <see cref="ResourceModel"/> was ordered. If this model is an organization, then this is the organization ID itself.

  • Description: string value

  • TemplateSummary: string value

  • Properties: List<KeyValuePair<string, string>> value

  • ResourceOrderFormTemplate: IFormTemplate value

  • IsCreationalResource: Indicates whether the resource represents the creation of a new object (e.g. new account creation).

  • HasCreationalResourceChild: Indicates whether the resource has at least one child resource that is a creational resource. If true, then it is possible to browse into it even if browsing hierarchical resources is disabled in the configuration.

  • IconBase64: string value

  • IsManualInteractionRequired: bool value

  • UriKeyComparer: static IEqualityComparer<ResourceModel> value

Example

POST http://localhost/api/v1/Orders/GetRootResources

Example Response

{     "UriKey": "sample",     "ResourceType": {},     "Name": "sample",     "ResourceTypeDescription": "sample",     "DisplayPath": "sample",     "CategoryName": "sample",     "CanBeOrdered": true,     "HasChildren": true,     "OrganizationId": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "TemplateSummary": "sample",     "Properties": {},     "ResourceOrderFormTemplate": {},     "IsCreationalResource": true,     "HasCreationalResourceChild": true,     "IconBase64": "sample",     "IsManualInteractionRequired": true,     "UriKeyComparer": {} }

Get Root Resources (GET)

Get Root Resources.

Route

URI

/api/v1/Orders/GetRootResources

Method

GET

Result

JSON – ResourceModel[]

Parameters

None

Response Structure Returns ResourceModel[] object containing:

  • UriKey: string value

  • ResourceType: The resource technology's primary key.

  • Name: string value

  • ResourceTypeDescription: string value

  • DisplayPath: string value

  • CategoryName: string value

  • CanBeOrdered: Indicates if the resource can be ordered. (A resource may be non-orderable even though it has children that are orderable.)

  • HasChildren: Indicates if the resource has child resources.

  • OrganizationId: The id of the organization from which the <see cref="ResourceModel"/> was ordered. If this model is an organization, then this is the organization ID itself.

  • Description: string value

  • TemplateSummary: string value

  • Properties: List<KeyValuePair<string, string>> value

  • ResourceOrderFormTemplate: IFormTemplate value

  • IsCreationalResource: Indicates whether the resource represents the creation of a new object (e.g. new account creation).

  • HasCreationalResourceChild: Indicates whether the resource has at least one child resource that is a creational resource. If true, then it is possible to browse into it even if browsing hierarchical resources is disabled in the configuration.

  • IconBase64: string value

  • IsManualInteractionRequired: bool value

  • UriKeyComparer: static IEqualityComparer<ResourceModel> value

Example

GET http://localhost/api/v1/Orders/GetRootResources

Example Response

{     
"UriKey": "sample",     
"ResourceType": {},     
"Name": "sample",     
"ResourceTypeDescription": "sample",     
"DisplayPath": "sample",     
"CategoryName": "sample",     
"CanBeOrdered": true,     
"HasChildren": true,     
"OrganizationId": "123e4567-e89b-12d3-a456-426614174000",     
"Description": "sample",     
"TemplateSummary": "sample",     
"Properties": {},     
"ResourceOrderFormTemplate": {},     
"IsCreationalResource": true,     
"HasCreationalResourceChild": true,     
"IconBase64": "sample",     
"IsManualInteractionRequired": true,     
"UriKeyComparer": {} 
}

Reject Erroneous Order Items (POST)

Rejects a set of erroneous orders.

Route

URI

/api/v1/Orders/RejectErroneousOrderItems

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

rejectOrderItemsRequest

RejectOrderItemsRequest

No

 

Example

POST http://localhost/api/v1/Orders/RejectErroneousOrderItems

Reject Order Items (POST)

Rejects a set of orders.

Route

URI

/api/v1/Orders/RejectOrderItems

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

rejectOrderItemsRequest

RejectOrderItemsRequest

No

 

Example

POST http://localhost/api/v1/Orders/RejectOrderItems

Storno Order Items (POST)

HardDelte or storno order items.

Route

URI

/api/v1/Orders/StornoOrderItems

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

stornOrderItemsRequest

StornOrderItemsRequest

No

 

Example

POST http://localhost/api/v1/Orders/StornoOrderItems

Submit Order (POST)

Submits an order for a user. (The grantee(s) of the order may differ from the current submitting user.)

Route

URI

/api/v1/Orders/SubmitOrder

Method

POST

Result

JSON – Dictionary<string, OrderResultModel>

Parameters

Name

Type

Mandatory

Description

submitOrderRequest

SubmitOrderRequest

No

 

Example

POST http://localhost/api/v1/Orders/SubmitOrder