API

System APIs

POST system/job-sequence-extensions/{jobSequenceExtensionId}/steps

Creates new step in a job sequence extension.

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

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
<JobSequenceExtensionStep>
2
     <AssemblyName
AssemblyName

Required/mandatory field

Name of assembly

>{String}</AssemblyName>
3
     <Description
Description

Description of the IOX step

This field is optional.

>{String}</Description>
4
     <CompanySettingDefinitions
CompanySettingDefinitions

Settings of the IOX step

This field is optional.

>
5
          <CompanySettingDefinition
CompanySettingDefinition

This field is optional.

>
6
               <Key
Key

Setting name used to reference the setting

This field is optional.

>{String}</Key>
7
          </CompanySettingDefinition>
8
     </CompanySettingDefinitions>
9
</JobSequenceExtensionStep>
1
{
2
     "jobSequenceExtensionStep": {
3
          "assemblyName
AssemblyName

Required/mandatory field

Name of assembly

": "{String}",
4
          "description
Description

Description of the IOX step

This field is optional.

": "{String}",
5
          "companySettingDefinitions
CompanySettingDefinitions

Settings of the IOX step

This field is optional.

": [
6
               {
7
                    "key
Key

Setting name used to reference the setting

This field is optional.

": "{String}"
8
               }
9
          ]
10
     }
11
}

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.

Format:
1
<JobSequenceExtensionStep>
2
     <JobSequenceExtensionStepId
JobSequenceExtensionStepId

IOX step identifier

>{Integer}</JobSequenceExtensionStepId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <AssemblyName
AssemblyName

Name of assembly

>{String}</AssemblyName>
5
     <Description
Description

Description of the IOX step

>{String}</Description>
6
     <CompanySettingDefinitions
CompanySettingDefinitions

Settings of the IOX step

>
7
          <CompanySettingDefinition>
8
               <Key
Key

Setting name used to reference the setting

>{String}</Key>
9
          </CompanySettingDefinition>
10
     </CompanySettingDefinitions>
11
</JobSequenceExtensionStep>
1
{
2
     "jobSequenceExtensionStep": {
3
          "jobSequenceExtensionStepId
JobSequenceExtensionStepId

IOX step identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "assemblyName
AssemblyName

Name of assembly

": "{String}",
6
          "description
Description

Description of the IOX step

": "{String}",
7
          "companySettingDefinitions
CompanySettingDefinitions

Settings of the IOX step

": [
8
               {
9
                    "key
Key

Setting name used to reference the setting

": "{String}"
10
               }
11
          ]
12
     }
13
}

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 105170 HTTP 404 Job Sequence Extension not found
Error 105207 HTTP 404 Step not found