API

Collaboration APIs

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

Keyfigures for Manufactoring Record Book (MRB)

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

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.

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.

Format:
1
<KeyFigures>
2
     <TotalRequirements
TotalRequirements

The total amount of requirements for this product.

>{Integer}</TotalRequirements>
3
     <FilesReadyForMRB
FilesReadyForMRB

The number of completed requirements. This includes requirements with files ready approved.

>{Integer}</FilesReadyForMRB>
4
     <FilesMissingPDF
FilesMissingPDF

Total count of all documents currently missing a PDF variant. PDF variants are used to in the MRB documentation.

>{Integer}</FilesMissingPDF>
5
     <RequirementsMissingFilesForMRB
RequirementsMissingFilesForMRB

The total count of missing required documents for the MRB. The count includes the current product level and all its sub structures.

>{Integer}</RequirementsMissingFilesForMRB>
6
     <RequirementsMissingFilesForInternalUse
RequirementsMissingFilesForInternalUse

The total count of required documents for internal use. The count includes the current product level and all its sub structures.

>{Integer}</RequirementsMissingFilesForInternalUse>
7
     <MissingTraceMaterials
MissingTraceMaterials

Number of missing trace on LCMs

>{Integer}</MissingTraceMaterials>
8
     <FileApprovalsByType>
9
          <FileApprovalByType>
10
               <UnapprovedFiles
UnapprovedFiles

dummy

>{Integer}</UnapprovedFiles>
11
               <ApprovalType>
12
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

>{Integer}</NotificationTypeId>
13
                    <Name
Name

Name of the approval rule

>{String}</Name>
14
               </ApprovalType>
15
          </FileApprovalByType>
16
     </FileApprovalsByType>
17
</KeyFigures>
1
{
2
     "keyFigures": {
3
          "totalRequirements
TotalRequirements

The total amount of requirements for this product.

": "{Integer}",
4
          "filesReadyForMRB
FilesReadyForMRB

The number of completed requirements. This includes requirements with files ready approved.

": "{Integer}",
5
          "filesMissingPDF
FilesMissingPDF

Total count of all documents currently missing a PDF variant. PDF variants are used to in the MRB documentation.

": "{Integer}",
6
          "requirementsMissingFilesForMRB
RequirementsMissingFilesForMRB

The total count of missing required documents for the MRB. The count includes the current product level and all its sub structures.

": "{Integer}",
7
          "requirementsMissingFilesForInternalUse
RequirementsMissingFilesForInternalUse

The total count of required documents for internal use. The count includes the current product level and all its sub structures.

": "{Integer}",
8
          "missingTraceMaterials
MissingTraceMaterials

Number of missing trace on LCMs

": "{Integer}",
9
          "fileApprovalsByType": [
10
               {
11
                    "unapprovedFiles
UnapprovedFiles

dummy

": "{Integer}",
12
                    "approvalType": {
13
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

Name of the approval rule

": "{String}"
15
                    }
16
               }
17
          ]
18
     }
19
}

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 is not found
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101420 HTTP 404 Setting definition not found