Collaboration APIs
Updates a file requirement on a uniquie identifier
| HTTP method | PUT |
| URI | https://api.rambase.net/collaboration/file-requirements/{fileRequirementId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {fileRequirementId} |
Unique identifier for Requirements
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 5293, version 4 |
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.
FileRequirement
This field is optional.
>Description
Description of file requirement
This field is optional.
>{String}</Description>RequiredForInternalUse
Sets requirements for internal documentation
This field is optional.
>{Boolean}</RequiredForInternalUse>RequiredForMRB
Sets requirements to Manufacturing Record book.
This field is optional.
>{Boolean}</RequiredForMRB>Context
This field is optional.
>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.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>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.
>ProductionOperationId
Production operation identifier
Minimum value: 1000
This field is optional.
>{Integer}</ProductionOperationId>PurchaseOrderItem
Value set from originating purchase ORDERITEMID
This field is optional.
>PurchaseOrderItemId
Item-/line-number of the purchase order
Minimum value: 1
This field is optional.
>{Integer}</PurchaseOrderItemId>PurchaseOrder
Value set from originating purchase ORDERID
This field is optional.
>PurchaseOrderId
Purchase order identifier
Minimum value: 100000
This field is optional.
>{Integer}</PurchaseOrderId>SalesOrderItem
Value set from the originating sales order item ORDERITMID
This field is optional.
>SalesOrderItemId
Sales order item identifier
Minimum value: 1
This field is optional.
>{Integer}</SalesOrderItemId>SalesOrder
Value set from the originating sales order ORDERID
This field is optional.
>SalesOrderId
Sales order identifier
Minimum value: 100000
This field is optional.
>{Integer}</SalesOrderId>FileRequirement
This field is optional.
": {Description
Description of file requirement
This field is optional.
": "{String}",RequiredForInternalUse
Sets requirements for internal documentation
This field is optional.
": "{Boolean}",RequiredForMRB
Sets requirements to Manufacturing Record book.
This field is optional.
": "{Boolean}",Context
This field is optional.
": {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.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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.
": {ProductionOperationId
Production operation identifier
Minimum value: 1000
This field is optional.
": "{Integer}"PurchaseOrderItem
Value set from originating purchase ORDERITEMID
This field is optional.
": {PurchaseOrderItemId
Item-/line-number of the purchase order
Minimum value: 1
This field is optional.
": "{Integer}",PurchaseOrder
Value set from originating purchase ORDERID
This field is optional.
": {PurchaseOrderId
Purchase order identifier
Minimum value: 100000
This field is optional.
": "{Integer}"SalesOrderItem
Value set from the originating sales order item ORDERITMID
This field is optional.
": {SalesOrderItemId
Sales order item identifier
Minimum value: 1
This field is optional.
": "{Integer}",SalesOrder
Value set from the originating sales order ORDERID
This field is optional.
": {SalesOrderId
Sales order identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
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 101420 HTTP 404 | Setting definition not found |