Collaboration APIs

GET collaboration/file-requirements

List of file requirements

HTTP method	GET
URI	https://api.rambase.net/collaboration/file-requirements
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	5226, version 9

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:

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.
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.
RequiredForInternalUse Boolean	Sets requirements for internal documentation.
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
RequiredForInternalUse Boolean	Sets requirements for internal documentation
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:

                                        <FileRequirements>
                                    

                                             <FileRequirement>
                                    

<FileRequirementId

FileRequirementId

Unique identifier for Requirements

>{Integer}</FileRequirementId>

<Status

Status

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

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

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

>{Datetime}</CreatedAt>

<UpdatedAt

UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>

<Description

Description

Description of file requirement

>{String}</Description>

<RequiredForInternalUse

RequiredForInternalUse

Sets requirements for internal documentation

>{Boolean}</RequiredForInternalUse>

<RequiredForMRB

RequiredForMRB

Sets requirements to Manufacturing Record book.

>{Boolean}</RequiredForMRB>

                                                  <FileType>
                                    

<FileTypeId

FileTypeId

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

>{Integer}</FileTypeId>

<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>

<FileTypeLink

FileTypeLink

Full doc reference to the FileType id

>{String}</FileTypeLink>

                                                  </FileType>
                                    

<Regarding

Regarding

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

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ItemType

ItemType

Type of item

>{String}</ItemType>

<ItemId

ItemId

Item-number of the object

>{Integer}</ItemId>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

<ItemLink

ItemLink

API reference to the item

>{String}</ItemLink>

                                                  </Regarding>
                                    

                                                  <Context>
                                    

<Product

Product

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

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                                       </Product>
                                    

<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.

<ProductionOperationId

ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>

<ProductionOperationLink

ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>

                                                       </ProductionOperation>
                                    

<PurchaseOrderItem

PurchaseOrderItem

Value set from originating purchase ORDERITEMID

<PurchaseOrderItemId

PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>

<PurchaseOrder

PurchaseOrder

Value set from originating purchase ORDERID

<PurchaseOrderId

PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>

<PurchaseOrderLink

PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>

                                                            </PurchaseOrder>
                                    

<PurchaseOrderItemLink

PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>

                                                       </PurchaseOrderItem>
                                    

<SalesOrderItem

SalesOrderItem

Value set from the originating sales order item ORDERITMID

<SalesOrderItemId

SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>

<SalesOrder

SalesOrder

Value set from the originating sales order ORDERID

<SalesOrderId

SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>

<SalesOrderLink

SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>

                                                            </SalesOrder>
                                    

<SalesOrderItemLink

SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>

                                                       </SalesOrderItem>
                                    

                                                  </Context>
                                    

<StopEvent

StopEvent

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

<EventTypeId

EventTypeId

RamBase event type identifier

>{Integer}</EventTypeId>

<EventTypeLink

EventTypeLink

RamBase event type reference

>{String}</EventTypeLink>

                                                  </StopEvent>
                                    

<FileRequirementLink

FileRequirementLink

Full docId for the file requirement.

>{String}</FileRequirementLink>

                                             </FileRequirement>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<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>

<FirstPage

FirstPage

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

>{String}</FirstPage>

<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>

<PreviousPage

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

>{String}</PreviousPage>

<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>

<NextPage

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

>{String}</NextPage>

<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>

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </FileRequirements>
                                    

{

                                             "fileRequirements": [
                                    

{

"fileRequirementId

FileRequirementId

Unique identifier for Requirements

": "{Integer}",

"status

Status

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

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

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

": "{Datetime}",

"updatedAt

UpdatedAt

Date and time of update

": "{Datetime}",

"description

Description

Description of file requirement

": "{String}",

"requiredForInternalUse

RequiredForInternalUse

Sets requirements for internal documentation

": "{Boolean}",

"requiredForMRB

RequiredForMRB

Sets requirements to Manufacturing Record book.

": "{Boolean}",

                                                       "fileType": {
                                    

"fileTypeId

FileTypeId

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

": "{Integer}",

"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}",

"fileTypeLink

FileTypeLink

Full doc reference to the FileType id

": "{String}"

},

"regarding

Regarding

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

": {

"objectType

ObjectType

Type of object

": "{String}",

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"itemType

ItemType

Type of item

": "{String}",

"itemId

ItemId

Item-number of the object

": "{Integer}",

"objectLink

ObjectLink

API reference to the object

": "{String}",

"itemLink

ItemLink

API reference to the item

": "{String}"

},

                                                       "context": {
                                    

"product

Product

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

": {

"productId

ProductId

Product identifier

": "{Integer}",

"productLink

ProductLink

Product reference

": "{String}"

},

"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.

": {

"productionOperationId

ProductionOperationId

Production operation identifier

": "{Integer}",

"productionOperationLink

ProductionOperationLink

Production operation reference

": "{String}"

},

"purchaseOrderItem

PurchaseOrderItem

Value set from originating purchase ORDERITEMID

": {

"purchaseOrderItemId

PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",

"purchaseOrder

PurchaseOrder

Value set from originating purchase ORDERID

": {

"purchaseOrderId

PurchaseOrderId

Purchase order identifier

": "{Integer}",

"purchaseOrderLink

PurchaseOrderLink

Purchase order reference

": "{String}"

},

"purchaseOrderItemLink

PurchaseOrderItemLink

Purchase order item reference

": "{String}"

},

"salesOrderItem

SalesOrderItem

Value set from the originating sales order item ORDERITMID

": {

"salesOrderItemId

SalesOrderItemId

Sales order item identifier

": "{Integer}",

"salesOrder

SalesOrder

Value set from the originating sales order ORDERID

": {

"salesOrderId

SalesOrderId

Sales order identifier

": "{Integer}",

"salesOrderLink

SalesOrderLink

Sales order reference

": "{String}"

},

"salesOrderItemLink

SalesOrderItemLink

Reference to the sales order item.

": "{String}"

}

},

"stopEvent

StopEvent

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

": {

"eventTypeId

EventTypeId

RamBase event type identifier

": "{Integer}",

"eventTypeLink

EventTypeLink

RamBase event type reference

": "{String}"

},

"fileRequirementLink

FileRequirementLink

Full docId for the file requirement.

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

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

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"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}",

"firstPage

FirstPage

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

": "{String}",

"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}",

"previousPage

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

": "{String}",

"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}",

"nextPage

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

": "{String}",

"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}",

"lastPage

LastPage

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

": "{String}",

"size

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 104978 HTTP 404

File type is not found