Production APIs
Resource for retrieving list of work orders in given production resource
HTTP method | GET |
URI | https://api.rambase.net/production/resources/{productionResourceId}/work-order-operations |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {productionResourceId} |
Production resource identifier
Integer, minimum 100000 |
Maximum page size ($top) | 60 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 3426, version 84 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
Active() Named filter | Active production work order operations |
All() Named filter | All production work order operations |
CanBeGrouped() Named filter | Production work order operations which can be grouped |
Completed() Named filter | Completed production work order operations |
Grouped() Named filter | Production work order operations which have been grouped |
MyTasks() Named filter | Production work order operations for current user |
NotGrouped() Named filter | Production work order operations which have not been grouped |
Production() Named filter | Production work order operations in production |
Ready() Named filter | Ready production work order operations |
Wait() Named filter | Waiting production work order operations |
ConfirmedCompletionDate Date | The confirmed date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CustomersReferenceNumber String | Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system. |
DocumentControllerId Integer | Reference to the employee who is a production management document controller. Available macros: currentUser() |
FinishedAt Datetime | Date and time of completion. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
HasPriority Boolean | Flag which indicates if Work Order Operation has been prioritized. |
IsOnHold Boolean | True if work order operation is on hold. |
IsPaused Boolean | True if work order operation is paused. |
LatestOperatorId Integer | Employee identifier. Available macros: currentUser() |
Location String | Unique abbreviation/short name of the location. |
Operation String | Name of the operation. |
PlannedFinishedAt Datetime | Date and time planned to finish. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
PlannedStartAt Datetime | Date and time planned to start. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
ProductDescription String | Description of the product. |
ProductId Integer | Product identifier. |
ProductionPlannerId Integer | Reference to the employee who is a production management planner. Available macros: currentUser() |
ProductionWorkOrderId Integer | Production work order identifier. |
ProductName String | Name of the product. |
ProductStructureMaterialProductName String | Product structure material's product name Name of the operation for operation lines. |
ProductUnitId Integer | Product unit identifier. |
ProjectLeaderId Integer | Reference to the employee who is a production management project leader. Available macros: currentUser() |
Quantity Decimal | Quantity of the work order operation. |
ReadyAt Datetime | Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
RequestedCompletionDate Date | The requested date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
SerialNumber String | Serial number of the product unit. |
StartedAt Datetime | Date and time work order operation actually started. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Status Integer | Production work order operation status. |
WorkOrderOperationGroupCreatedAt Datetime | Creation date for Group Work Order Operation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
WorkOrderOperationGroupId Integer | Work order operation group identifier. |
WorkOrderOperationGroupMemberSortIndex Integer | Sort index of work order operation in the group. |
WorkOrderOperationGroupPriority Integer | Type of work order operation group. |
WorkOrderOperationGroupType String | Type of work order operation group. |
WorkOrderOperationId Integer | Production work order operation identifier. |
Read more about filters and sorting on how to use sortable parameters
ConfirmedCompletionDate Date | The confirmed date of completion for the production work order |
CreatedAt Datetime | Date and time of creation |
CustomersReferenceNumber String | Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system. |
DocumentControllerId Integer | Reference to the employee who is a production management document controller. |
FinishedAt Datetime | Date and time of completion |
HasPriority Boolean | Flag which indicates if Work Order Operation has been prioritized |
IsOnHold Boolean | True if work order operation is on hold |
IsPaused Boolean | True if work order operation is paused |
LatestOperatorId Integer | Employee identifier |
Location String | Unique abbreviation/short name of the location |
Operation String | Name of the operation |
PlannedFinishedAt Datetime | Date and time planned to finish. Specified by the planned work order operation. |
PlannedStartAt Datetime | Date and time planned to start. Specified by the planned work order operation. |
ProductDescription String | Description of the product |
ProductId Integer | Product identifier |
ProductionPlannerId Integer | Reference to the employee who is a production management planner. |
ProductionWorkOrderId Integer | Production work order identifier |
ProductName String | Name of the product |
ProductStructureMaterialProductName String | Product structure material's product name Name of the operation for operation lines. |
ProjectLeaderId Integer | Reference to the employee who is a production management project leader. |
Quantity Decimal | Quantity of the work order operation |
ReadyAt Datetime | Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements. |
RequestedCompletionDate Date | The requested date of completion for the production work order. |
StartedAt Datetime | Date and time work order operation actually started |
Status Integer | Production work order operation status |
WorkOrderOperationGroupCreatedAt Datetime | Creation date for Group Work Order Operation |
WorkOrderOperationGroupId Integer | Work order operation group identifier |
WorkOrderOperationGroupMemberSortIndex Integer | Sort index of work order operation in the group |
WorkOrderOperationGroupPriority Integer | Type of work order operation group |
WorkOrderOperationGroupType String | Type of work order operation group |
WorkOrderOperationId Integer | Production work order operation identifier |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SerialNumber
Serial number of the product unit
>{String}</SerialNumber>PlannedOperationId
Planned work order operation identifier
>{Integer}</PlannedOperationId>IsOperationLocked
Is locked, must not be moved. Can be due to inspection by external source.
>{Boolean}</IsOperationLocked>PlannedOperationLink
Planned work order operation reference
>{String}</PlannedOperationLink>WorkOrderOperationId
Production work order operation identifier
>{Integer}</WorkOrderOperationId>Status
Production work order operation status
Possible domain values can be found here
>{Integer}</Status>PlannedStartAt
Date and time planned to start. Specified by the planned work order operation.
>{Datetime}</PlannedStartAt>PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
>{Datetime}</PlannedFinishedAt>StartedAt
Date and time work order operation actually started
>{Datetime}</StartedAt>FinishedAt
Date and time of completion
>{Datetime}</FinishedAt>WaitTimeEndsAt
Date and time quetime is completed
>{Datetime}</WaitTimeEndsAt>ReadyAt
Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements.
>{Datetime}</ReadyAt>IsPaused
True if work order operation is paused
>{Boolean}</IsPaused>HasPriority
Flag which indicates if Work Order Operation has been prioritized
>{Boolean}</HasPriority>Quantity
Quantity of the work order operation
>{Decimal}</Quantity>CanBeGrouped
A flag indicating if work order operation can be grouped
>{Boolean}</CanBeGrouped>PickingStatus
Picking status of work order operation
Possible domain values can be found here
>{Integer}</PickingStatus>PlannedStartAtMargin
Critical days
>{Integer}</PlannedStartAtMargin>IsProcessingCompleted
True if processing is completed
>{Boolean}</IsProcessingCompleted>PlannedRunTime
Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation
>{Decimal}</PlannedRunTime>RunTime
The time required to process a piece or lot at a specific operation. Specified in hours.
>{Decimal}</RunTime>IsSetupCompleted
True if setup changeover is completed
>{Boolean}</IsSetupCompleted>SetupTime
Time in hours used for setup changeover
>{Decimal}</SetupTime>IsCleanupCompleted
True if cleanup changeover is completed
>{Boolean}</IsCleanupCompleted>CleanupTime
Time in hours used for cleanup changeover
>{Decimal}</CleanupTime>IsOnHold
True if work order operation is on hold
>{Boolean}</IsOnHold>OnHoldAt
Date and time work order operation was set on hold
>{Datetime}</OnHoldAt>OnHoldTo
Date and time work order operation should be on hold to
>{Datetime}</OnHoldTo>Category
A category of work order operation on hold reason
Possible domain values can be found here
>{Integer}</Category>Reason
Reason for setting work order operation on hold
>{String}</Reason>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
>{String}</CustomersReferenceNumber>RequestedCompletionDate
The requested date of completion for the production work order.
>{Date}</RequestedCompletionDate>ConfirmedCompletionDate
The confirmed date of completion for the production work order
>{Date}</ConfirmedCompletionDate>ProductRevision
Product revision used for this production work order
>{String}</ProductRevision>IsOnHold
Flag to indicate if production work order is on hold
>{Boolean}</IsOnHold>OnHoldAt
Date of putting production work order on hold
>{Datetime}</OnHoldAt>OnHoldTo
Date and time production work order should be on hold to
>{Datetime}</OnHoldTo>Category
A category of production work order on hold reason
Possible domain values can be found here
>{Integer}</Category>Reason
Reason of putting production work order on hold
>{String}</Reason>Database
Database of the object
>{String}</Database>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>Location
The location of the production.
>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProjectLeader
Reference to the employee who is a production management project leader.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>DocumentController
Reference to the employee who is a production management document controller.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>WaitTime
The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.
>{Decimal}</WaitTime>SetupTime
Changeover pre/setup time in hours
>{Decimal}</SetupTime>CleanupTime
Changeover post/cleanup time in hours
>{Decimal}</CleanupTime>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>WorkOrderOperationLink
Work order operation reference
>{String}</WorkOrderOperationLink>MemberId
Work order operation group member's identifier
>{Integer}</MemberId>SortIndex
Sort index of work order operation in the group
>{Integer}</SortIndex>WorkOrderOperationGroupId
Work order operation group identifier
>{Integer}</WorkOrderOperationGroupId>Name
Name of Work Order Operation Group
>{String}</Name>CreatedAt
Creation date for Group Work Order Operation
>{Date}</CreatedAt>Priority
A priority index for work order operation group
>{Integer}</Priority>WorkOrderOperationGroupLink
Work order operation group's reference
>{String}</WorkOrderOperationGroupLink>MemberLink
Work order operation group's member reference
>{String}</MemberLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>SerialNumber
Serial number of the product unit
": "{String}"PlannedOperationId
Planned work order operation identifier
": "{Integer}",IsOperationLocked
Is locked, must not be moved. Can be due to inspection by external source.
": "{Boolean}",PlannedOperationLink
Planned work order operation reference
": "{String}"WorkOrderOperationId
Production work order operation identifier
": "{Integer}",Status
Production work order operation status
Possible domain values can be found here
": "{Integer}",PlannedStartAt
Date and time planned to start. Specified by the planned work order operation.
": "{Datetime}",PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
": "{Datetime}",StartedAt
Date and time work order operation actually started
": "{Datetime}",FinishedAt
Date and time of completion
": "{Datetime}",WaitTimeEndsAt
Date and time quetime is completed
": "{Datetime}",ReadyAt
Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements.
": "{Datetime}",IsPaused
True if work order operation is paused
": "{Boolean}",HasPriority
Flag which indicates if Work Order Operation has been prioritized
": "{Boolean}",Quantity
Quantity of the work order operation
": "{Decimal}",CanBeGrouped
A flag indicating if work order operation can be grouped
": "{Boolean}",PickingStatus
Picking status of work order operation
Possible domain values can be found here
": "{Integer}",PlannedStartAtMargin
Critical days
": "{Integer}",IsProcessingCompleted
True if processing is completed
": "{Boolean}",PlannedRunTime
Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation
": "{Decimal}",RunTime
The time required to process a piece or lot at a specific operation. Specified in hours.
": "{Decimal}"IsSetupCompleted
True if setup changeover is completed
": "{Boolean}",SetupTime
Time in hours used for setup changeover
": "{Decimal}",IsCleanupCompleted
True if cleanup changeover is completed
": "{Boolean}",CleanupTime
Time in hours used for cleanup changeover
": "{Decimal}"IsOnHold
True if work order operation is on hold
": "{Boolean}",OnHoldAt
Date and time work order operation was set on hold
": "{Datetime}",OnHoldTo
Date and time work order operation should be on hold to
": "{Datetime}",Category
A category of work order operation on hold reason
Possible domain values can be found here
": "{Integer}",Reason
Reason for setting work order operation on hold
": "{String}"ProductionWorkOrderId
Production work order identifier
": "{Integer}",CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
": "{String}",RequestedCompletionDate
The requested date of completion for the production work order.
": "{Date}",ConfirmedCompletionDate
The confirmed date of completion for the production work order
": "{Date}",ProductRevision
Product revision used for this production work order
": "{String}",IsOnHold
Flag to indicate if production work order is on hold
": "{Boolean}",OnHoldAt
Date of putting production work order on hold
": "{Datetime}",OnHoldTo
Date and time production work order should be on hold to
": "{Datetime}",Category
A category of production work order on hold reason
Possible domain values can be found here
": "{Integer}",Reason
Reason of putting production work order on hold
": "{String}"Database
Database of the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"Location
The location of the production.
": {ShortName
Unique abbreviation/short name of the location
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ProjectLeader
Reference to the employee who is a production management project leader.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"DocumentController
Reference to the employee who is a production management document controller.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ProductionWorkOrderLink
Production work order reference
": "{String}"ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",WaitTime
The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.
": "{Decimal}",SetupTime
Changeover pre/setup time in hours
": "{Decimal}",CleanupTime
Changeover post/cleanup time in hours
": "{Decimal}"ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"ProductStructureVersionId
Product structure identifier
": "{Integer}",ProductStructureVersionLink
Product structure reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"WorkOrderOperationLink
Work order operation reference
": "{String}"MemberId
Work order operation group member's identifier
": "{Integer}",SortIndex
Sort index of work order operation in the group
": "{Integer}",WorkOrderOperationGroupId
Work order operation group identifier
": "{Integer}",Name
Name of Work Order Operation Group
": "{String}",CreatedAt
Creation date for Group Work Order Operation
": "{Date}",Type
Type of work order operation group
Possible domain values can be found here
": "{String}",Priority
A priority index for work order operation group
": "{Integer}",WorkOrderOperationGroupLink
Work order operation group's reference
": "{String}"MemberLink
Work order operation group's member reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 101030 HTTP 404 | Role not found |
Error 105969 HTTP 400 | Start date is required |
Error 105970 HTTP 400 | End date is required |