System APIs
See AOP/100030
| HTTP method | POST |
| URI | https://api.rambase.net/system/api/api-operations/100030 |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 200 |
| API resource identifier | 342, version 5 |
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.
ExternalProcessStatus
Required/mandatory field
Status of external process
>{Integer}</ExternalProcessStatus>Message
Message for the output job. Typically an error message. Always specified if external process has failed.
This field is optional.
>{String}</Message>ExternalProcessStatus
Required/mandatory field
Status of external process
": "{Integer}",Message
Message for the output job. Typically an error message. Always specified if external process has failed.
This field is optional.
": "{String}"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.
| $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 |
| $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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 101013 HTTP 404 | Sub-module not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 101014 HTTP 400 | Output job must be in status 8 when making changes to external progress status |