Procurement APIs
List of file requirements for a procurement order item
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/orders/{purchaseOrderId}/items/{itemId}/file-requirements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/line-number of the purchase order
Integer, minimum 1 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5871, version 1 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| CreatedAt Datetime | Automatically generated timestamp field maintained by the execution engine (when document data is updated). Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Description String | Descriptive name of a requirement, inherited from FIT or as specified if created manually. |
| FileRequirementId Integer | Unique identifier for Requirements. |
| FileTypeId Integer | Reference to the file type this requirement will be fulfilled by. |
| ProductId Integer | Product identifier. |
| ProductionOperationId Integer | Production operation identifier. |
| RequiredForInternalUse Boolean | Sets requirements for internal documentation. |
| RequiredForMRB Boolean | Sets requirements to Manufacturing Record book. |
| Status Integer | The status of a requirement indicates if the requirement for documentation is completed. |
| StopEventTypeId Integer | RamBase event type identifier. |
| UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Automatically generated timestamp field maintained by the execution engine (when document data is updated) |
| Description String | Descriptive name of a requirement, inherited from FIT or as specified if created manually |
| FileRequirementId Integer | Unique identifier for Requirements |
| FileTypeId Integer | Reference to the file type this requirement will be fulfilled by. |
| ProductId Integer | Product identifier |
| ProductionOperationId Integer | Production operation identifier |
| RequiredForInternalUse Boolean | Sets requirements for internal documentation |
| RequiredForMRB Boolean | Sets requirements to Manufacturing Record book. |
| Status Integer | The status of a requirement indicates if the requirement for documentation is completed |
| StopEventTypeId Integer | RamBase event type identifier |
| UpdatedAt Datetime | Date and time of update |
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.
FileRequirementId
Unique identifier for Requirements
>{Integer}</FileRequirementId>Status
The status of a requirement indicates if the requirement for documentation is completed
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Automatically generated timestamp field maintained by the execution engine (when document data is updated)
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>Description
Description of file requirement
>{String}</Description>RequiredForInternalUse
Sets requirements for internal documentation
>{Boolean}</RequiredForInternalUse>RequiredForMRB
Sets requirements to Manufacturing Record book.
>{Boolean}</RequiredForMRB>FileTypeId
Reference to the file type this requirement will be fulfilled by.
>{Integer}</FileTypeId>FileTypeLink
Full doc reference to the FileType id
>{String}</FileTypeLink>Product
Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.
>ProductId
Product identifier
>{Integer}</ProductId>ProductLink
Product reference
>{String}</ProductLink>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.
>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>PurchaseOrderItem
Value set from originating purchase ORDERITEMID
>PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>PurchaseOrder
Value set from originating purchase ORDERID
>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>PurchaseOrderItemLink
Purchase order item reference
>{String}</PurchaseOrderItemLink>SalesOrderItem
Value set from the originating sales order item ORDERITMID
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrder
Value set from the originating sales order ORDERID
>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>StopEvent
Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV
>EventTypeId
RamBase event type identifier
>{Integer}</EventTypeId>EventTypeLink
RamBase event type reference
>{String}</EventTypeLink>FileRequirementLink
Full docId for the file requirement.
>{String}</FileRequirementLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>FileRequirementId
Unique identifier for Requirements
": "{Integer}",Status
The status of a requirement indicates if the requirement for documentation is completed
Possible domain values can be found here
": "{Integer}",CreatedAt
Automatically generated timestamp field maintained by the execution engine (when document data is updated)
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",Description
Description of file requirement
": "{String}",RequiredForInternalUse
Sets requirements for internal documentation
": "{Boolean}",RequiredForMRB
Sets requirements to Manufacturing Record book.
": "{Boolean}",FileTypeId
Reference to the file type this requirement will be fulfilled by.
": "{Integer}",FileTypeLink
Full doc reference to the FileType id
": "{String}"Product
Requirement is based on matching ARTIT. If this field is used, a file linked to SSA.ITM must be matching this artit.
": {ProductId
Product identifier
": "{Integer}",ProductLink
Product reference
": "{String}"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.
": {ProductionOperationId
Production operation identifier
": "{Integer}",ProductionOperationLink
Production operation reference
": "{String}"PurchaseOrderItem
Value set from originating purchase ORDERITEMID
": {PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",PurchaseOrder
Value set from originating purchase ORDERID
": {PurchaseOrderId
Purchase order identifier
": "{Integer}",PurchaseOrderLink
Purchase order reference
": "{String}"PurchaseOrderItemLink
Purchase order item reference
": "{String}"SalesOrderItem
Value set from the originating sales order item ORDERITMID
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrder
Value set from the originating sales order ORDERID
": {SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"StopEvent
Optional event type which requires file requirement to be met (ProductionOperationCompleted, ProductActivated). DOV
": {EventTypeId
RamBase event type identifier
": "{Integer}",EventTypeLink
RamBase event type reference
": "{String}"FileRequirementLink
Full docId for the file requirement.
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100050 HTTP 403 | No admittance as customer {0} |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |