API

Collaboration APIs

POST collaboration/file-requirements

Create a new file requirement

HTTP method POST
URI https://api.rambase.net/collaboration/file-requirements
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5264, 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
<FileRequirement>
2
     <Description
Description

Description of file requirement

This field is optional.

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

Sets requirements to Manufacturing Record book.

Default value: False

This field is optional.

>{Boolean}</RequiredForMRB>
4
     <FileType>
5
          <FileTypeId
FileTypeId

Required/mandatory field

Reference to the file type this requirement will be fulfilled by.

Minimum value: 100000

>{Integer}</FileTypeId>
6
     </FileType>
7
     <Regarding
Regarding

Required/mandatory field

Owning object. Used to link a requirement to a operations or other objects that has documentation requirements.

>
8
          <ObjectType
ObjectType

Required/mandatory field

Type of object

>{String}</ObjectType>
9
          <ObjectId
ObjectId

Required/mandatory field

Identifier of the object

Minimum value: 100000

>{Integer}</ObjectId>
10
          <ItemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

>{Integer}</ItemId>
11
     </Regarding>
12
     <Context
Context

This field is optional.

>
13
          <Product
Product

Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.

This field is optional.

>
14
               <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
15
          </Product>
16
          <ProductionOperation
ProductionOperation

Requirement is based on matching OPRNO. If this field is used, a file linked to PWO with this OPR in kit item must be matching this OPRNO.

This field is optional.

>
17
               <ProductionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

>{Integer}</ProductionOperationId>
18
          </ProductionOperation>
19
          <PurchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

This field is optional.

>
20
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

Minimum value: 1

This field is optional.

>{Integer}</PurchaseOrderItemId>
21
               <PurchaseOrder
PurchaseOrder

Value set from originating purchase ORDERID

This field is optional.

>
22
                    <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

>{Integer}</PurchaseOrderId>
23
               </PurchaseOrder>
24
          </PurchaseOrderItem>
25
          <SalesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

This field is optional.

>
26
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

Minimum value: 1

This field is optional.

>{Integer}</SalesOrderItemId>
27
               <SalesOrder
SalesOrder

Value set from the originating sales order ORDERID

This field is optional.

>
28
                    <SalesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

>{Integer}</SalesOrderId>
29
               </SalesOrder>
30
          </SalesOrderItem>
31
     </Context>
32
     <StopEvent
StopEvent

Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV

This field is optional.

>
33
          <EventTypeId
EventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

>{Integer}</EventTypeId>
34
     </StopEvent>
35
</FileRequirement>
1
{
2
     "fileRequirement": {
3
          "description
Description

Description of file requirement

This field is optional.

": "{String}",
4
          "requiredForMRB
RequiredForMRB

Sets requirements to Manufacturing Record book.

Default value: False

This field is optional.

": "{Boolean}",
5
          "fileType": {
6
               "fileTypeId
FileTypeId

Required/mandatory field

Reference to the file type this requirement will be fulfilled by.

Minimum value: 100000

": "{Integer}"
7
          },
8
          "regarding
Regarding

Required/mandatory field

Owning object. Used to link a requirement to a operations or other objects that has documentation requirements.

": {
9
               "objectType
ObjectType

Required/mandatory field

Type of object

": "{String}",
10
               "objectId
ObjectId

Required/mandatory field

Identifier of the object

Minimum value: 100000

": "{Integer}",
11
               "itemId
ItemId

Item-number of the object

Minimum value: 1

This field is optional.

": "{Integer}"
12
          },
13
          "context
Context

This field is optional.

": {
14
               "product
Product

Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.

This field is optional.

": {
15
                    "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
16
               },
17
               "productionOperation
ProductionOperation

Requirement is based on matching OPRNO. If this field is used, a file linked to PWO with this OPR in kit item must be matching this OPRNO.

This field is optional.

": {
18
                    "productionOperationId
ProductionOperationId

Production operation identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
19
               },
20
               "purchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

This field is optional.

": {
21
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

Minimum value: 1

This field is optional.

": "{Integer}",
22
                    "purchaseOrder
PurchaseOrder

Value set from originating purchase ORDERID

This field is optional.

": {
23
                         "purchaseOrderId
PurchaseOrderId

Purchase order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
24
                    }
25
               },
26
               "salesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

This field is optional.

": {
27
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

Minimum value: 1

This field is optional.

": "{Integer}",
28
                    "salesOrder
SalesOrder

Value set from the originating sales order ORDERID

This field is optional.

": {
29
                         "salesOrderId
SalesOrderId

Sales order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
30
                    }
31
               }
32
          },
33
          "stopEvent
StopEvent

Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV

This field is optional.

": {
34
               "eventTypeId
EventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
35
          }
36
     }
37
}

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
<FileRequirement>
2
     <FileRequirementId
FileRequirementId

Unique identifier for Requirements

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

The status of a requirement indicates if the requirement for documentation is completed

Possible domain values can be found here

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

Automatically generated timestamp field maintained by the execution engine (when document data is updated)

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

Date and time of update

>{Datetime}</UpdatedAt>
6
     <Description
Description

Description of file requirement

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

Sets requirements for internal documentation

>{Boolean}</RequiredForInternalUse>
8
     <RequiredForMRB
RequiredForMRB

Sets requirements to Manufacturing Record book.

>{Boolean}</RequiredForMRB>
9
     <FileType>
10
          <FileTypeId
FileTypeId

Reference to the file type this requirement will be fulfilled by.

>{Integer}</FileTypeId>
11
          <FileTypeLink
FileTypeLink

Full doc reference to the FileType id

>{String}</FileTypeLink>
12
     </FileType>
13
     <Regarding
Regarding

Owning object. Used to link a requirement to a operations or other objects that has documentation requirements.

>
14
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
15
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
16
          <ItemType
ItemType

Type of item

>{String}</ItemType>
17
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
18
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
19
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
20
     </Regarding>
21
     <Context>
22
          <Product
Product

Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.

>
23
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
24
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
25
          </Product>
26
          <ProductionOperation
ProductionOperation

Requirement is based on matching OPRNO. If this field is used, a file linked to PWO with this OPR in kit item must be matching this OPRNO.

>
27
               <ProductionOperationId
ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>
28
               <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
29
          </ProductionOperation>
30
          <PurchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

>
31
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
32
               <PurchaseOrder
PurchaseOrder

Value set from originating purchase ORDERID

>
33
                    <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
34
                    <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>
35
               </PurchaseOrder>
36
               <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
37
          </PurchaseOrderItem>
38
          <SalesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

>
39
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
40
               <SalesOrder
SalesOrder

Value set from the originating sales order ORDERID

>
41
                    <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
42
                    <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
43
               </SalesOrder>
44
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
45
          </SalesOrderItem>
46
     </Context>
47
     <StopEvent
StopEvent

Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV

>
48
          <EventTypeId
EventTypeId

RamBase event type identifier

>{Integer}</EventTypeId>
49
          <EventTypeLink
EventTypeLink

RamBase event type reference

>{String}</EventTypeLink>
50
     </StopEvent>
51
</FileRequirement>
1
{
2
     "fileRequirement": {
3
          "fileRequirementId
FileRequirementId

Unique identifier for Requirements

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

The status of a requirement indicates if the requirement for documentation is completed

Possible domain values can be found here

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

Automatically generated timestamp field maintained by the execution engine (when document data is updated)

": "{Datetime}",
6
          "updatedAt
UpdatedAt

Date and time of update

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

Description of file requirement

": "{String}",
8
          "requiredForInternalUse
RequiredForInternalUse

Sets requirements for internal documentation

": "{Boolean}",
9
          "requiredForMRB
RequiredForMRB

Sets requirements to Manufacturing Record book.

": "{Boolean}",
10
          "fileType": {
11
               "fileTypeId
FileTypeId

Reference to the file type this requirement will be fulfilled by.

": "{Integer}",
12
               "fileTypeLink
FileTypeLink

Full doc reference to the FileType id

": "{String}"
13
          },
14
          "regarding
Regarding

Owning object. Used to link a requirement to a operations or other objects that has documentation requirements.

": {
15
               "objectType
ObjectType

Type of object

": "{String}",
16
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
17
               "itemType
ItemType

Type of item

": "{String}",
18
               "itemId
ItemId

Item-number of the object

": "{Integer}",
19
               "objectLink
ObjectLink

API reference to the object

": "{String}",
20
               "itemLink
ItemLink

API reference to the item

": "{String}"
21
          },
22
          "context": {
23
               "product
Product

Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.

": {
24
                    "productId
ProductId

Product identifier

": "{Integer}",
25
                    "productLink
ProductLink

Product reference

": "{String}"
26
               },
27
               "productionOperation
ProductionOperation

Requirement is based on matching OPRNO. If this field is used, a file linked to PWO with this OPR in kit item must be matching this OPRNO.

": {
28
                    "productionOperationId
ProductionOperationId

Production operation identifier

": "{Integer}",
29
                    "productionOperationLink
ProductionOperationLink

Production operation reference

": "{String}"
30
               },
31
               "purchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

": {
32
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
33
                    "purchaseOrder
PurchaseOrder

Value set from originating purchase ORDERID

": {
34
                         "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
35
                         "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

": "{String}"
36
                    },
37
                    "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
38
               },
39
               "salesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

": {
40
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
41
                    "salesOrder
SalesOrder

Value set from the originating sales order ORDERID

": {
42
                         "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
43
                         "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
44
                    },
45
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
46
               }
47
          },
48
          "stopEvent
StopEvent

Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV

": {
49
               "eventTypeId
EventTypeId

RamBase event type identifier

": "{Integer}",
50
               "eventTypeLink
EventTypeLink

RamBase event type reference

": "{String}"
51
          }
52
     }
53
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101523 HTTP 400 Format is mandatory