API

Collaboration APIs

GET production/work-orders/{productionWorkOrderId}/file-requirements

List of file requirements regarding a production order

HTTP method GET
URI https://api.rambase.net/production/work-orders/{productionWorkOrderId}/file-requirements
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionWorkOrderId} Production work order identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5349, 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.

Format:
1
1

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.

MissingFiles() Named filter Filter requirements that has not yet been met by a matching file
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.
PurchaseOrderId Integer Purchase order identifier.
PurchaseOrderItemId Integer Item-/line-number of the purchase order.
RegardingItemId Integer Item-number of the object.
RegardingObjectId Integer Identifier of the object.
RegardingObjectType String Type of object.
RequiredForMRB Boolean Sets requirements to Manufacturing Record book.
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.
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
PurchaseOrderId Integer Purchase order identifier
PurchaseOrderItemId Integer Item-/line-number of the purchase order
RegardingItemId Integer Item-number of the object
RegardingObjectId Integer Identifier of the object
RegardingObjectType String Type of object
RequiredForMRB Boolean Sets requirements to Manufacturing Record book.
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier
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.

Format:
1
<FileRequirements>
2
     <FileRequirement>
3
          <FileRequirementId
FileRequirementId

Unique identifier for Requirements

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

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

Possible domain values can be found here

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

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

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

Date and time of update

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

Description of file requirement

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

Sets requirements for internal documentation

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

Sets requirements to Manufacturing Record book.

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

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

>{Integer}</FileTypeId>
12
               <Name
Name

Strong typed name for a file type

This field is greyed out because it is an expandable field. You have to add $expand=FileRequirement.FileType.Name in your request URI to get this field

>{String}</Name>
13
               <FileTypeLink
FileTypeLink

Full doc reference to the FileType id

>{String}</FileTypeLink>
14
          </FileType>
15
          <Regarding
Regarding

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

>
16
               <ObjectType
ObjectType

Type of object

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

Identifier of the object

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

Type of item

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

Item-number of the object

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

API reference to the object

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

API reference to the item

>{String}</ItemLink>
22
          </Regarding>
23
          <Context>
24
               <Product
Product

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

>
25
                    <ProductId
ProductId

Product identifier

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

Product reference

>{String}</ProductLink>
27
               </Product>
28
               <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.

>
29
                    <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Production operation reference

>{String}</ProductionOperationLink>
31
               </ProductionOperation>
32
               <PurchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

>
33
                    <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

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

Value set from originating purchase ORDERID

>
35
                         <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

>{String}</PurchaseOrderLink>
37
                    </PurchaseOrder>
38
                    <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
39
               </PurchaseOrderItem>
40
               <SalesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

>
41
                    <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Value set from the originating sales order ORDERID

>
43
                         <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
45
                    </SalesOrder>
46
                    <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
47
               </SalesOrderItem>
48
          </Context>
49
          <StopEvent
StopEvent

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

>
50
               <EventTypeId
EventTypeId

RamBase event type identifier

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

RamBase event type reference

>{String}</EventTypeLink>
52
          </StopEvent>
53
          <FileRequirementLink
FileRequirementLink

Full docId for the file requirement.

>{String}</FileRequirementLink>
54
     </FileRequirement>
55
     <Paging
Paging

Detailed paging information for this list.

>
56
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
57
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
58
          <Page
Page

Page index

>{Integer}</Page>
59
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
60
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
61
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
62
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
63
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
64
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
65
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
66
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
67
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
68
     </Paging>
69
</FileRequirements>
1
{
2
     "fileRequirements": [
3
          {
4
               "fileRequirementId
FileRequirementId

Unique identifier for Requirements

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

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

Possible domain values can be found here

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

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

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

Date and time of update

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

Description of file requirement

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

Sets requirements for internal documentation

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

Sets requirements to Manufacturing Record book.

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

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

": "{Integer}",
13
                    "name
Name

Strong typed name for a file type

This field is greyed out because it is an expandable field. You have to add $expand=FileRequirement.FileType.Name in your request URI to get this field

": "{String}",
14
                    "fileTypeLink
FileTypeLink

Full doc reference to the FileType id

": "{String}"
15
               },
16
               "regarding
Regarding

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

": {
17
                    "objectType
ObjectType

Type of object

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

Identifier of the object

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

Type of item

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

Item-number of the object

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

API reference to the object

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

API reference to the item

": "{String}"
23
               },
24
               "context": {
25
                    "product
Product

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

": {
26
                         "productId
ProductId

Product identifier

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

Product reference

": "{String}"
28
                    },
29
                    "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.

": {
30
                         "productionOperationId
ProductionOperationId

Production operation identifier

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

Production operation reference

": "{String}"
32
                    },
33
                    "purchaseOrderItem
PurchaseOrderItem

Value set from originating purchase ORDERITEMID

": {
34
                         "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

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

Value set from originating purchase ORDERID

": {
36
                              "purchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

": "{String}"
38
                         },
39
                         "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
40
                    },
41
                    "salesOrderItem
SalesOrderItem

Value set from the originating sales order item ORDERITMID

": {
42
                         "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Value set from the originating sales order ORDERID

": {
44
                              "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
46
                         },
47
                         "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
48
                    }
49
               },
50
               "stopEvent
StopEvent

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

": {
51
                    "eventTypeId
EventTypeId

RamBase event type identifier

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

RamBase event type reference

": "{String}"
53
               },
54
               "fileRequirementLink
FileRequirementLink

Full docId for the file requirement.

": "{String}"
55
          }
56
     ],
57
     "paging
Paging

Detailed paging information for this list.

": {
58
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
59
          "position
Position

Position of the first element in the list

": "{Integer}",
60
          "page
Page

Page index

": "{Integer}",
61
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
62
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
63
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
64
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
65
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
66
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
67
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
68
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
69
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
70
     }
71
}

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 100199 HTTP 404 Location not found
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required