API

Production APIs

PUT production/mrb-specifications/{mrbSpecificationId}

Updates details on an MRB specification

HTTP method PUT
URI https://api.rambase.net/production/mrb-specifications/{mrbSpecificationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {mrbSpecificationId} MRB specification identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5554, version 2

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

This field is optional.

>
2
     <Description
Description

Descrtiptive name for this book template

This field is optional.

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

Reference to the template pdf file version to be used in the MRB

This field is optional.

>
4
          <FileVersionId
FileVersionId

Version of the file

Minimum value: 100

This field is optional.

>{Integer}</FileVersionId>
5
          <File
File

Reference to the template pdf file to be used in the MRB

This field is optional.

>
6
               <FileId
FileId

File identifier

Minimum value: 100000

This field is optional.

>{Integer}</FileId>
7
          </File>
8
     </TemplateFile>
9
     <ExclusivelyFor
ExclusivelyFor

This field is optional.

>
10
          <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
11
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
12
     </ExclusivelyFor>
13
</MRBSpecification>
1
{
2
     "mRBSpecification
MRBSpecification

This field is optional.

": {
3
          "description
Description

Descrtiptive name for this book template

This field is optional.

": "{String}",
4
          "templateFile
TemplateFile

Reference to the template pdf file version to be used in the MRB

This field is optional.

": {
5
               "fileVersionId
FileVersionId

Version of the file

Minimum value: 100

This field is optional.

": "{Integer}",
6
               "file
File

Reference to the template pdf file to be used in the MRB

This field is optional.

": {
7
                    "fileId
FileId

File identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
8
               }
9
          },
10
          "exclusivelyFor
ExclusivelyFor

This field is optional.

": {
11
               "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
12
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
13
          }
14
     }
15
}

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 107729 HTTP 400 Customer account id {0} does not exist.
Error 107730 HTTP 400 Supplier account id {0} does not exist
Error 107731 HTTP 400 The file {0} does not exist