Production APIs

POST production/mrb-specifications

Creates a new MRB specification

HTTP method	POST
URI	https://api.rambase.net/production/mrb-specifications
Supported formats	Xml, Html, Json (ex. $format=json)
Successful HTTP status code	201
API resource identifier	5555, 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:

                                        <MRBSpecification>
                                    

<Description

Description

Required/mandatory field

Descrtiptive name for this book template

>{String}</Description>

<ExclusivelyFor

ExclusivelyFor

This field is optional.

<ObjectId

ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

This field is optional.

>{String}</ObjectType>

                                             </ExclusivelyFor>
                                    

                                        </MRBSpecification>
                                    

{

                                             "mRBSpecification": {
                                    

"description

Description

Required/mandatory field

Descrtiptive name for this book template

": "{String}",

"exclusivelyFor

ExclusivelyFor

This field is optional.

": {

"objectId

ObjectId

Identifier of the object

This field is optional.

": "{Integer}",

"objectType

ObjectType

Type of object

This field is optional.

": "{String}"

}

}

}

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:

                                        <MRBSpecification>
                                    

<MRBSpecificationId

MRBSpecificationId

MRB specification identifier

>{Integer}</MRBSpecificationId>

<Status

Status

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

>{Integer}</Status>

<Description

Description

Descrtiptive name for this book template

>{String}</Description>

<CreatedAt

CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

>{Datetime}</CreatedAt>

<TemplateFile

TemplateFile

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

<FileVersionId

FileVersionId

Version of the file

>{Integer}</FileVersionId>

<File

File

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

<FileId

FileId

File identifier

>{Integer}</FileId>

<FileLink

FileLink

File reference

>{String}</FileLink>

                                                  </File>
                                    

<FileVersionLink

FileVersionLink

File version reference

>{String}</FileVersionLink>

                                             </TemplateFile>
                                    

                                             <ExclusivelyFor>
                                    

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<FirstName

FirstName

First name of the customer/supplier

>{String}</FirstName>

<Name

Name

Name of the customer/supplier, or last name if it is a person.

>{String}</Name>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

                                             </ExclusivelyFor>
                                    

                                        </MRBSpecification>
                                    

{

                                             "mRBSpecification": {
                                    

"mRBSpecificationId

MRBSpecificationId

MRB specification identifier

": "{Integer}",

"status

Status

Status indicator for Active, edit or obsoleted book

Possible domain values can be found here

": "{Integer}",

"description

Description

Descrtiptive name for this book template

": "{String}",

"createdAt

CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

": "{Datetime}",

"templateFile

TemplateFile

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

": {

"fileVersionId

FileVersionId

Version of the file

": "{Integer}",

"file

File

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

": {

"fileId

FileId

File identifier

": "{Integer}",

"fileLink

FileLink

File reference

": "{String}"

},

"fileVersionLink

FileVersionLink

File version reference

": "{String}"

},

                                                  "exclusivelyFor": {
                                    

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"firstName

FirstName

First name of the customer/supplier

": "{String}",

"name

Name

Name of the customer/supplier, or last name if it is a person.

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}"

}

}

}

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