API

System APIs

GET system/api/operation-instances/{operationInstanceId}

Operation instance details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/api/operation-instances/{operationInstanceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {operationInstanceId} Operation instance identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1927, version 18

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

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

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
<OperationInstance>
2
     <OperationInstanceId
OperationInstanceId

Operation instance identifier

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

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

Possible domain values can be found here

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

The mutual exclusion (mutex) definition/formula

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

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

Date and time the operation instance was created

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

Reference to the creator

>
7
          <UserId
UserId

User identifier

>{Integer}</UserId>
8
          <UserLink
UserLink

User reference

>{String}</UserLink>
9
     </CreatedBy>
10
     <CreatedFor>
11
          <Database
Database

Database of the object

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

Identifier of the object

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

Type of object

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

Identifier of the object

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

Item-number of the object

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

Type of item

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

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
19
     </CreatedFor>
20
     <ApiOperation>
21
          <ApiOperationId
ApiOperationId

Api operation identifiers

>{Integer}</ApiOperationId>
22
          <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
23
     </ApiOperation>
24
     <ObjectReference>
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
     <Error>
34
          <Message
Message

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

>{String}</Message>
35
          <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.

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

Stack trace for details about the error

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

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

>
38
               <ErrorMessageId
ErrorMessageId

Error message identifier

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

Error message reference

>{String}</ErrorMessageLink>
40
          </ErrorMessage>
41
          <Parameters>
42
               <Parameter>
43
                    <Index
Index

Error Key

>{Integer}</Index>
44
                    <Value
Value

Value of the error parameter

>{String}</Value>
45
               </Parameter>
46
          </Parameters>
47
          <InnerErrors>
48
               <Error>
49
                    <Message
Message

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

>{String}</Message>
50
                    <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.

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

Stack trace for details about the error

>{String}</StackTrace>
52
                    <ErrorMessage>
53
                         <ErrorMessageId
ErrorMessageId

Error message identifier

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

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

>{String}</ErrorMessageLink>
55
                    </ErrorMessage>
56
                    <Parameters>
57
                         <Parameter>
58
                              <Index
Index

Error Key

>{Integer}</Index>
59
                              <Value
Value

Value of the error parameter

>{String}</Value>
60
                         </Parameter>
61
                    </Parameters>
62
               </Error>
63
          </InnerErrors>
64
     </Error>
65
     <ResultValues>
66
          <ResultValue>
67
               <Key
Key

Key of the result value

>{String}</Key>
68
               <Value
Value

Value of the result value

>{String}</Value>
69
          </ResultValue>
70
     </ResultValues>
71
     <SystemJob
SystemJob

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

>
72
          <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

Percent complete

>{Integer}</PercentComplete>
75
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

>{String}</ObjectLink>
77
     </SystemJob>
78
</OperationInstance>
1
{
2
     "operationInstance": {
3
          "operationInstanceId
OperationInstanceId

Operation instance identifier

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

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

Possible domain values can be found here

": "{Integer}",
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=Mutex in your request URI to get this field

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

Date and time the operation instance was created

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

Reference to the creator

": {
8
               "userId
UserId

User identifier

": "{Integer}",
9
               "userLink
UserLink

User reference

": "{String}"
10
          },
11
          "createdFor": {
12
               "database
Database

Database of the object

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

Identifier of the object

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

Type of object

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

Identifier of the object

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

Item-number of the object

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

Type of item

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

API reference to the item

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

Internal RamBase identifier of the object/item

": "{String}"
20
          },
21
          "apiOperation": {
22
               "apiOperationId
ApiOperationId

Api operation identifiers

": "{Integer}",
23
               "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
24
          },
25
          "objectReference": {
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
          "error": {
35
               "message
Message

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

": "{String}",
36
               "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.

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

Stack trace for details about the error

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

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

": {
39
                    "errorMessageId
ErrorMessageId

Error message identifier

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

Error message reference

": "{String}"
41
               },
42
               "parameters": [
43
                    {
44
                         "index
Index

Error Key

": "{Integer}",
45
                         "value
Value

Value of the error parameter

": "{String}"
46
                    }
47
               ],
48
               "innerErrors": [
49
                    {
50
                         "message
Message

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

": "{String}",
51
                         "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.

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

Stack trace for details about the error

": "{String}",
53
                         "errorMessage": {
54
                              "errorMessageId
ErrorMessageId

Error message identifier

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

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

": "{String}"
56
                         },
57
                         "parameters": [
58
                              {
59
                                   "index
Index

Error Key

": "{Integer}",
60
                                   "value
Value

Value of the error parameter

": "{String}"
61
                              }
62
                         ]
63
                    }
64
               ]
65
          },
66
          "resultValues": [
67
               {
68
                    "key
Key

Key of the result value

": "{String}",
69
                    "value
Value

Value of the result value

": "{String}"
70
               }
71
          ],
72
          "systemJob
SystemJob

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

": {
73
               "objectId
ObjectId

Identifier of the object

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

Type of object

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

Percent complete

": "{Integer}",
76
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
78
          }
79
     }
80
}

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