API

Production APIs

POST production/resources/{productionResourceId}/restricted-to-operators

Adds new operator assigned to production resource

HTTP method POST
URI https://api.rambase.net/production/resources/{productionResourceId}/restricted-to-operators
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceId} Production resource identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3309, version 9

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
<Operator>
2
     <Employee>
3
          <EmployeeId
EmployeeId

Required/mandatory field

Operator ID for multioperator resources.

Minimum value: 100

Maximum value: 100000

>{Integer}</EmployeeId>
4
     </Employee>
5
</Operator>
1
{
2
     "operator": {
3
          "employee": {
4
               "employeeId
EmployeeId

Required/mandatory field

Operator ID for multioperator resources.

Minimum value: 100

Maximum value: 100000

": "{Integer}"
5
          }
6
     }
7
}

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
<Operator>
2
     <OperatorId
OperatorId

Identifier of restricted operator

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

Status of production resource's restricted operator

Possible domain values can be found here

>{Integer}</Status>
4
     <Employee>
5
          <EmployeeId
EmployeeId

Operator ID for multioperator resources.

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

Employee reference

>{String}</EmployeeLink>
7
     </Employee>
8
</Operator>
1
{
2
     "operator": {
3
          "operatorId
OperatorId

Identifier of restricted operator

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

Status of production resource's restricted operator

Possible domain values can be found here

": "{Integer}",
5
          "employee": {
6
               "employeeId
EmployeeId

Operator ID for multioperator resources.

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

Employee reference

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

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
Error 100207 HTTP 404 Production resource not found {0}