API

Production APIs

POST production/work-order-operation-groups

Creates new production resource work order operation workgroup

HTTP method POST
URI https://api.rambase.net/production/work-order-operation-groups
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3491, version 8

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
<WorkOrderOperationGroup>
2
     <Type
Type

Required/mandatory field

Type of work order operation group

Applicable domain values can be found here

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

Work order operation group description

This field is optional.

>
{String}</Description>
4
     <ProductionResource>
5
          <ProductionResourceId
ProductionResourceId

Required/mandatory field

Production resource identifier

Minimum value: 100000

>
{Integer}</ProductionResourceId>
6
     </ProductionResource>
7
</WorkOrderOperationGroup>
1
{
2
     "workOrderOperationGroup": {
3
          "type
Type

Required/mandatory field

Type of work order operation group

Applicable domain values can be found here

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

Work order operation group description

This field is optional.

":
"{String}",
5
          "productionResource": {
6
               "productionResourceId
ProductionResourceId

Required/mandatory field

Production resource identifier

Minimum value: 100000

":
"{Integer}"
7
          }
8
     }
9
}

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

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
<WorkOrderOperationGroup>
2
     <WorkOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

Status of work order operation group

Possible domain values can be found here

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

Name of Work Order Operation Group

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

Work order operation group description

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

Creation date for Group Work Order Operation

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

Type of work order operation group

Possible domain values can be found here

>
{String}</Type>
8
     <Priority
Priority

A priority index for work order operation group

>
{Integer}</Priority>
9
     <Operator>
10
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
11
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
12
     </Operator>
13
     <ProductionResource>
14
          <ProductionResourceId
ProductionResourceId

Production resource identifier

>
{Integer}</ProductionResourceId>
15
          <ProductionResourceLink
ProductionResourceLink

Production resource reference

>
{String}</ProductionResourceLink>
16
     </ProductionResource>
17
</WorkOrderOperationGroup>
1
{
2
     "workOrderOperationGroup": {
3
          "workOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

Status of work order operation group

Possible domain values can be found here

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

Name of Work Order Operation Group

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

Work order operation group description

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

Creation date for Group Work Order Operation

":
"{Datetime}",
8
          "type
Type

Type of work order operation group

Possible domain values can be found here

":
"{String}",
9
          "priority
Priority

A priority index for work order operation group

":
"{Integer}",
10
          "operator": {
11
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
12
               "employeeLink
EmployeeLink

Employee reference

":
"{String}"
13
          },
14
          "productionResource": {
15
               "productionResourceId
ProductionResourceId

Production resource identifier

":
"{Integer}",
16
               "productionResourceLink
ProductionResourceLink

Production resource reference

":
"{String}"
17
          }
18
     }
19
}

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 107736 HTTP 400 Work order operation group name is required
Error 107737 HTTP 400 Work order operation group with given name already exists
Error 107779 HTTP 400 Priority cannot be lower than 1
Error 107765 HTTP 400 Work order operation group with given priority already exists