API

Production APIs

POST production/resource-categories

Creates new production resource category

HTTP method POST
URI https://api.rambase.net/production/resource-categories
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5135, version 3

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
<ProductionResourceCategory>
2
     <Name
Name

Required/mandatory field

Production resource category name

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

Production resource category description

This field is optional.

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

This field is optional.

>
5
          <ProductionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

Minimum value: 100000

This field is optional.

>{Integer}</ProductionResourceCategoryId>
6
     </ParentProductionResourceCategory>
7
</ProductionResourceCategory>
1
{
2
     "productionResourceCategory": {
3
          "name
Name

Required/mandatory field

Production resource category name

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

Production resource category description

This field is optional.

": "{String}",
5
          "parentProductionResourceCategory
ParentProductionResourceCategory

This field is optional.

": {
6
               "productionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

Minimum value: 100000

This field is optional.

": "{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
<ProductionResourceCategory>
2
     <ProductionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

Production resource category status

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Production resource category name

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

Production resource category description

>{String}</Description>
7
     <Label
Label

Unique name for the production resource category . Built using name from this and levels above

>{String}</Label>
8
     <TreeLevel
TreeLevel

Production resource category's tree level

>{Integer}</TreeLevel>
9
     <ParentProductionResourceCategory>
10
          <ProductionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

>{Integer}</ProductionResourceCategoryId>
11
          <ProductionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

>{String}</ProductionResourceCategoryLink>
12
          <ParentProductionResourceCategory>
13
               <ProductionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

>{Integer}</ProductionResourceCategoryId>
14
               <Name
Name

Production resource category name

>{String}</Name>
15
               <TreeLevel
TreeLevel

Production resource category's tree level

>{Integer}</TreeLevel>
16
               <ProductionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

>{String}</ProductionResourceCategoryLink>
17
          </ParentProductionResourceCategory>
18
     </ParentProductionResourceCategory>
19
</ProductionResourceCategory>
1
{
2
     "productionResourceCategory": {
3
          "productionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

Production resource category status

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "name
Name

Production resource category name

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

Production resource category description

": "{String}",
8
          "label
Label

Unique name for the production resource category . Built using name from this and levels above

": "{String}",
9
          "treeLevel
TreeLevel

Production resource category's tree level

": "{Integer}",
10
          "parentProductionResourceCategory": {
11
               "productionResourceCategoryId
ProductionResourceCategoryId

Reference to the level above this production resource category. If empty then this is the top location.

": "{Integer}",
12
               "productionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

": "{String}",
13
               "parentProductionResourceCategory": {
14
                    "productionResourceCategoryId
ProductionResourceCategoryId

Production resource category identifier

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

Production resource category name

": "{String}",
16
                    "treeLevel
TreeLevel

Production resource category's tree level

": "{Integer}",
17
                    "productionResourceCategoryLink
ProductionResourceCategoryLink

Production resource category reference

": "{String}"
18
               }
19
          }
20
     }
21
}

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 107118 HTTP 400 This name of production resource category already exists on this level
Error 107120 HTTP 400 Parent production resource category does not exist
Error 107122 HTTP 400 Name of production resource category cannot be empty
Error 107124 HTTP 400 You cannot use a comma in the name of production resource category