API

System APIs

PUT system/job-sequence-extensions/{jobSequenceExtensionId}

Update details of a job sequence extension

HTTP method PUT
URI https://api.rambase.net/system/job-sequence-extensions/{jobSequenceExtensionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {jobSequenceExtensionId} Job sequence extension identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 4120, version 6

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
<JobSequenceExtension
JobSequenceExtension

This field is optional.

>
2
     <Name
Name

Name of job sequence extension

This field is optional.

>{String}</Name>
3
     <WebhookURL
WebhookURL

Url to external webhook endpoint. It will be trigged when files are uploaded to Azure blob storage.

This field is optional.

>{String}</WebhookURL>
4
     <JobSequence
JobSequence

Identifier of the job sequence definition to which the IO extension is related

This field is optional.

>
5
          <JobSequenceId
JobSequenceId

Job sequence identifier

Minimum value: 10000

This field is optional.

>{Integer}</JobSequenceId>
6
     </JobSequence>
7
     <StopAfterExtensionSteps
StopAfterExtensionSteps

Whether the IOD used by this IOX should stop execution after the IOX step has finished.

This field is optional.

>{Boolean}</StopAfterExtensionSteps>
8
</JobSequenceExtension>
1
{
2
     "jobSequenceExtension
JobSequenceExtension

This field is optional.

": {
3
          "name
Name

Name of job sequence extension

This field is optional.

": "{String}",
4
          "webhookURL
WebhookURL

Url to external webhook endpoint. It will be trigged when files are uploaded to Azure blob storage.

This field is optional.

": "{String}",
5
          "jobSequence
JobSequence

Identifier of the job sequence definition to which the IO extension is related

This field is optional.

": {
6
               "jobSequenceId
JobSequenceId

Job sequence identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
7
          },
8
          "stopAfterExtensionSteps
StopAfterExtensionSteps

Whether the IOD used by this IOX should stop execution after the IOX step has finished.

This field is optional.

": "{Boolean}"
9
     }
10
}

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.

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
1

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 101814 HTTP 404 Employee not found