API

System APIs

GET system/api/operation-instances

List of all operation instances

HTTP method GET
URI https://api.rambase.net/system/api/operation-instances
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1926, version 20

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.

Format:
1
1

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"
$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.

ApiOperationId Integer Api operation identifiers.
CreatedAt Datetime Date and time the operation instance was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer User identifier. Available macros: currentUser()
CreatedForDatabase String Database of the object.
CreatedForItemId Integer Item-number of the object.
CreatedForItemType Docref-archsubname Type of item.
CreatedForObjectId Integer Identifier of the object.
CreatedForObjectType Docref-dbarch Type of object.
CreatedForRamBaseKey String Internal RamBase identifier of the object/item.
ErrorMessageId Integer Error message identifier.
OperationInstanceId Integer Operation instance identifier.
Status Integer Status of the instance, 2 = started, 7 = error, 9 = finished.
SystemJobId Integer Identifier of the object.
SystemJobType String Type of object.

Read more about filters and sorting on how to use sortable parameters

ApiOperationId Integer Api operation identifiers
CreatedAt Datetime Date and time the operation instance was created
CreatedBy Integer User identifier
CreatedForDatabase String Database of the object
CreatedForItemId Integer Item-number of the object
CreatedForItemType Docref-archsubname Type of item
CreatedForObjectId Integer Identifier of the object
CreatedForObjectType Docref-dbarch Type of object
CreatedForRamBaseKey String Internal RamBase identifier of the object/item
ErrorMessageId Integer Error message identifier
OperationInstanceId Integer Operation instance identifier
Status Integer Status of the instance, 2 = started, 7 = error, 9 = finished
SystemJobId Integer Identifier of the object
SystemJobType String Type of object

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.

Format:
1
<OperationInstances>
2
     <OperationInstance>
3
          <OperationInstanceId
OperationInstanceId

Operation instance identifier

>{Integer}</OperationInstanceId>
4
          <Status
Status

Status of the instance, 2 = started, 7 = error, 9 = finished

Possible domain values can be found here

>{Integer}</Status>
5
          <Mutex
Mutex

The mutual exclusion (mutex) definition/formula

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Mutex in your request URI to get this field

>{String}</Mutex>
6
          <CreatedAt
CreatedAt

Date and time the operation instance was created

>{Datetime}</CreatedAt>
7
          <CreatedBy
CreatedBy

Reference to the creator

>
8
               <UserId
UserId

User identifier

>{Integer}</UserId>
9
               <Name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.CreatedBy.Name in your request URI to get this field

>{String}</Name>
10
               <FirstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.CreatedBy.FirstName in your request URI to get this field

>{String}</FirstName>
11
               <UserLink
UserLink

User reference

>{String}</UserLink>
12
          </CreatedBy>
13
          <CreatedFor>
14
               <Database
Database

Database of the object

>{String}</Database>
15
               <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
16
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
17
               <ObjectLink
ObjectLink

Identifier of the object

>{String}</ObjectLink>
18
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
19
               <ItemType
ItemType

Type of item

>{String}</ItemType>
20
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
21
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
22
          </CreatedFor>
23
          <ObjectReference>
24
               <Database
Database

Database of the object

>{String}</Database>
25
               <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
26
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
27
               <ObjectLink
ObjectLink

Identifier of the object

>{String}</ObjectLink>
28
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
29
               <ItemType
ItemType

Type of item

>{String}</ItemType>
30
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
31
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
32
          </ObjectReference>
33
          <ApiOperation>
34
               <ApiOperationId
ApiOperationId

Api operation identifiers

>{Integer}</ApiOperationId>
35
               <Name
Name

Name of the Api Operation

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.ApiOperation.Name in your request URI to get this field

>{String}</Name>
36
               <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
37
          </ApiOperation>
38
          <Error>
39
               <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Error.Message in your request URI to get this field

>{String}</Message>
40
               <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Error.TranslatedMessage in your request URI to get this field

>{String}</TranslatedMessage>
41
               <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
42
               <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
43
                    <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
44
                    <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
45
               </ErrorMessage>
46
          </Error>
47
          <SystemJob
SystemJob

Contains a reference to the system job, if a system job was started

>
48
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
49
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
50
               <PercentComplete
PercentComplete

Percent complete

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.SystemJob.PercentComplete in your request URI to get this field

>{Integer}</PercentComplete>
51
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
52
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
53
          </SystemJob>
54
          <OperationInstanceLink
OperationInstanceLink

Operation instance reference

>{String}</OperationInstanceLink>
55
     </OperationInstance>
56
     <Paging
Paging

Detailed paging information for this list.

>
57
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
58
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
59
          <Page
Page

Page index

>{Integer}</Page>
60
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
61
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
62
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
63
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
64
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
65
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
66
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
67
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
68
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
69
     </Paging>
70
</OperationInstances>
1
{
2
     "operationInstances": [
3
          {
4
               "operationInstanceId
OperationInstanceId

Operation instance identifier

": "{Integer}",
5
               "status
Status

Status of the instance, 2 = started, 7 = error, 9 = finished

Possible domain values can be found here

": "{Integer}",
6
               "mutex
Mutex

The mutual exclusion (mutex) definition/formula

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Mutex in your request URI to get this field

": "{String}",
7
               "createdAt
CreatedAt

Date and time the operation instance was created

": "{Datetime}",
8
               "createdBy
CreatedBy

Reference to the creator

": {
9
                    "userId
UserId

User identifier

": "{Integer}",
10
                    "name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.CreatedBy.Name in your request URI to get this field

": "{String}",
11
                    "firstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.CreatedBy.FirstName in your request URI to get this field

": "{String}",
12
                    "userLink
UserLink

User reference

": "{String}"
13
               },
14
               "createdFor": {
15
                    "database
Database

Database of the object

": "{String}",
16
                    "objectId
ObjectId

Identifier of the object

": "{String}",
17
                    "objectType
ObjectType

Type of object

": "{String}",
18
                    "objectLink
ObjectLink

Identifier of the object

": "{String}",
19
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
20
                    "itemType
ItemType

Type of item

": "{String}",
21
                    "itemLink
ItemLink

API reference to the item

": "{String}",
22
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
23
               },
24
               "objectReference": {
25
                    "database
Database

Database of the object

": "{String}",
26
                    "objectId
ObjectId

Identifier of the object

": "{String}",
27
                    "objectType
ObjectType

Type of object

": "{String}",
28
                    "objectLink
ObjectLink

Identifier of the object

": "{String}",
29
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
30
                    "itemType
ItemType

Type of item

": "{String}",
31
                    "itemLink
ItemLink

API reference to the item

": "{String}",
32
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
33
               },
34
               "apiOperation": {
35
                    "apiOperationId
ApiOperationId

Api operation identifiers

": "{Integer}",
36
                    "name
Name

Name of the Api Operation

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.ApiOperation.Name in your request URI to get this field

": "{String}",
37
                    "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
38
               },
39
               "error": {
40
                    "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Error.Message in your request URI to get this field

": "{String}",
41
                    "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.Error.TranslatedMessage in your request URI to get this field

": "{String}",
42
                    "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
43
                    "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
44
                         "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
45
                         "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
46
                    }
47
               },
48
               "systemJob
SystemJob

Contains a reference to the system job, if a system job was started

": {
49
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
50
                    "objectType
ObjectType

Type of object

": "{String}",
51
                    "percentComplete
PercentComplete

Percent complete

This field is greyed out because it is an expandable field. You have to add $expand=OperationInstance.SystemJob.PercentComplete in your request URI to get this field

": "{Integer}",
52
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
53
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
54
               },
55
               "operationInstanceLink
OperationInstanceLink

Operation instance reference

": "{String}"
56
          }
57
     ],
58
     "paging
Paging

Detailed paging information for this list.

": {
59
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
60
          "position
Position

Position of the first element in the list

": "{Integer}",
61
          "page
Page

Page index

": "{Integer}",
62
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
63
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
64
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
65
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
66
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
67
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
68
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
69
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
70
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
71
     }
72
}

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 100620 HTTP 400 Message is required