Collaboration APIs
Creates a new file requirement template
| HTTP method | POST |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/planned-file-requirements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 5260, version 5 |
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.
Description
Description of planned file requirement
This field is optional.
>{String}</Description>RequiredForMRB
Sets requirements to Manufacturing Record book.
Default value: False
This field is optional.
>{Boolean}</RequiredForMRB>FileTypeId
Required/mandatory field
Link to filetypeId
Minimum value: 100000
>{Integer}</FileTypeId>ProductionOperation
Originating OPR id from FIT.
This field is optional.
>ProductionOperationId
Production operation identifier
Minimum value: 1000
This field is optional.
>{Integer}</ProductionOperationId>Description
Description of planned file requirement
This field is optional.
": "{String}",RequiredForMRB
Sets requirements to Manufacturing Record book.
Default value: False
This field is optional.
": "{Boolean}",FileTypeId
Required/mandatory field
Link to filetypeId
Minimum value: 100000
": "{Integer}"ProductionOperation
Originating OPR id from FIT.
This field is optional.
": {ProductionOperationId
Production operation identifier
Minimum value: 1000
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. |
| $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.
PlannedFileRequirementId
Unique identifier for requirement template
>{Integer}</PlannedFileRequirementId>Status
The status of a RQT is 4 = active or 9 = inactive
Possible domain values can be found here
>{Integer}</Status>Description
Description of planned file requirement
>{String}</Description>RequiredForMRB
Sets requirements to Manufacturing Record book.
>{Boolean}</RequiredForMRB>CreatedAt
Automatically generated timestamp field maintained by the execution engine (when a document is created)
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>FileTypeId
Link to filetypeId
>{Integer}</FileTypeId>FileTypeLink
Full doc reference to the FileType id
>{String}</FileTypeLink>ProductionOperation
Originating OPR id from FIT.
>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>PlannedFileRequirementId
Unique identifier for requirement template
": "{Integer}",Status
The status of a RQT is 4 = active or 9 = inactive
Possible domain values can be found here
": "{Integer}",Description
Description of planned file requirement
": "{String}",RequiredForMRB
Sets requirements to Manufacturing Record book.
": "{Boolean}",CreatedAt
Automatically generated timestamp field maintained by the execution engine (when a document is created)
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",FileTypeId
Link to filetypeId
": "{Integer}",FileTypeLink
Full doc reference to the FileType id
": "{String}"ProductionOperation
Originating OPR id from FIT.
": {ProductionOperationId
Production operation identifier
": "{Integer}",ProductionOperationLink
Production operation reference
": "{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 107247 HTTP 400 | File requirement template not found |
| Error 101420 HTTP 404 | Setting definition not found |