API

Product APIs

GET product/structure-versions/aggregated-production-times

List of product structure versions together with their aggregated production times (average, longest, shortest time)

HTTP method GET
URI https://api.rambase.net/product/structure-versions/aggregated-production-times
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6215, 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.

AverageCleanupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AverageRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AverageSetupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
CleanupTime Decimal Changeover post/cleanup time in hours.
DeviationCleanupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
DeviationRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
DeviationSetupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
LongestCleanupTime Decimal Longest cleanup time out of all completed work order operations taken into average times calculation.
LongestRunTime Decimal Longest run time out of all completed work order operations taken into average times calculation.
LongestSetupTime Decimal Longest setup time out of all completed work order operations taken into average times calculation.
NumberOfCompletedProductionWorkOrders Integer Number of completed work order operations taken into average times calculation.
ProductName String Name of the product.
RunTime Decimal Runtime of the product structure operation. Changeover time is not included here.
SetupTime Decimal Changeover pre/setup time in hours.
ShortestCleanupTime Decimal Shortest cleanup time out of all completed work order operations taken into average times calculation.
ShortestRunTime Decimal Shortest run time out of all completed work order operations taken into average times calculation.
ShortestSetupTime Decimal Shortest setup time out of all completed work order operations taken into average times calculation.

Read more about filters and sorting on how to use sortable parameters

AverageCleanupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AverageRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AverageSetupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
CleanupTime Decimal Changeover post/cleanup time in hours
DeviationCleanupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
DeviationRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
DeviationSetupTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
LongestCleanupTime Decimal Longest cleanup time out of all completed work order operations taken into average times calculation
LongestRunTime Decimal Longest run time out of all completed work order operations taken into average times calculation
LongestSetupTime Decimal Longest setup time out of all completed work order operations taken into average times calculation
NumberOfCompletedProductionWorkOrders Integer Number of completed work order operations taken into average times calculation
ProductName String Name of the product
RunTime Decimal Runtime of the product structure operation. Changeover time is not included here.
SetupTime Decimal Changeover pre/setup time in hours
ShortestCleanupTime Decimal Shortest cleanup time out of all completed work order operations taken into average times calculation
ShortestRunTime Decimal Shortest run time out of all completed work order operations taken into average times calculation
ShortestSetupTime Decimal Shortest setup time out of all completed work order operations taken into average times calculation

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
<ProductStructureVersionAggregatedProductionTimes>
2
     <ProductStructureVersionAggregatedProductionTime>
3
          <ProductStructureVersion>
4
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Status of product structure

Possible domain values can be found here

>{Integer}</Status>
6
               <Name
Name

Name of the product structure version

>{String}</Name>
7
               <Version
Version

Version number of this product structure

>{Integer}</Version>
8
               <Revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</Revision>
9
               <ProductStructure>
10
                    <Product
Product

The product this structure is valid for

>
11
                         <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
12
                         <Status
Status

Status of the product

Possible domain values can be found here

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

Name of the product

>{String}</Name>
14
                         <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
15
                         <Description
Description

Description of the product

>{String}</Description>
16
                         <ProductLink
ProductLink

Product identifier

>{String}</ProductLink>
17
                    </Product>
18
               </ProductStructure>
19
               <ProductStructureVersionLink
ProductStructureVersionLink

Product structure identifier

>{String}</ProductStructureVersionLink>
20
          </ProductStructureVersion>
21
          <PlannedProductionTimes>
22
               <Processing>
23
                    <RunTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

>{Decimal}</RunTime>
24
               </Processing>
25
               <Changeover>
26
                    <SetupTime
SetupTime

Changeover pre/setup time in hours

>{Decimal}</SetupTime>
27
                    <CleanupTime
CleanupTime

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
28
               </Changeover>
29
          </PlannedProductionTimes>
30
          <AggregatedProductionTimes>
31
               <NumberOfCompletedProductionWorkOrders
NumberOfCompletedProductionWorkOrders

Numbers of completed production work orders

>{Integer}</NumberOfCompletedProductionWorkOrders>
32
               <Processing>
33
                    <AverageRunTime
AverageRunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</AverageRunTime>
34
                    <ShortestRunTime
ShortestRunTime

Shortest run time out of all completed work order operations taken into average times calculation

>{Decimal}</ShortestRunTime>
35
                    <LongestRunTime
LongestRunTime

Longest run time out of all completed work order operations taken into average times calculation

>{Decimal}</LongestRunTime>
36
                    <DeviationRunTime
DeviationRunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</DeviationRunTime>
37
               </Processing>
38
               <Changeover>
39
                    <Setup>
40
                         <AverageSetupTime
AverageSetupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</AverageSetupTime>
41
                         <ShortestSetupTime
ShortestSetupTime

Shortest setup time out of all completed work order operations taken into average times calculation

>{Decimal}</ShortestSetupTime>
42
                         <LongestSetupTime
LongestSetupTime

Longest setup time out of all completed work order operations taken into average times calculation

>{Decimal}</LongestSetupTime>
43
                         <DeviationSetupTime
DeviationSetupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</DeviationSetupTime>
44
                    </Setup>
45
                    <Cleanup>
46
                         <AverageCleanupTime
AverageCleanupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</AverageCleanupTime>
47
                         <ShortestCleanupTime
ShortestCleanupTime

Shortest cleanup time out of all completed work order operations taken into average times calculation

>{Decimal}</ShortestCleanupTime>
48
                         <LongestCleanupTime
LongestCleanupTime

Longest cleanup time out of all completed work order operations taken into average times calculation

>{Decimal}</LongestCleanupTime>
49
                         <DeviationCleanupTime
DeviationCleanupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>{Decimal}</DeviationCleanupTime>
50
                    </Cleanup>
51
               </Changeover>
52
          </AggregatedProductionTimes>
53
     </ProductStructureVersionAggregatedProductionTime>
54
     <Paging
Paging

Detailed paging information for this list.

>
55
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
58
          <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>
59
          <FirstPage
FirstPage

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

>{String}</FirstPage>
60
          <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>
61
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
62
          <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>
63
          <NextPage
NextPage

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

>{String}</NextPage>
64
          <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>
65
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
67
     </Paging>
68
</ProductStructureVersionAggregatedProductionTimes>
1
{
2
     "productStructureVersionAggregatedProductionTimes": [
3
          {
4
               "productStructureVersion": {
5
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Status of product structure

Possible domain values can be found here

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

Name of the product structure version

": "{String}",
8
                    "version
Version

Version number of this product structure

": "{Integer}",
9
                    "revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}",
10
                    "productStructure": {
11
                         "product
Product

The product this structure is valid for

": {
12
                              "productId
ProductId

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

": "{String}",
15
                              "type
Type

Type of product

Possible domain values can be found here

": "{String}",
16
                              "description
Description

Description of the product

": "{String}",
17
                              "productLink
ProductLink

Product identifier

": "{String}"
18
                         }
19
                    },
20
                    "productStructureVersionLink
ProductStructureVersionLink

Product structure identifier

": "{String}"
21
               },
22
               "plannedProductionTimes": {
23
                    "processing": {
24
                         "runTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

": "{Decimal}"
25
                    },
26
                    "changeover": {
27
                         "setupTime
SetupTime

Changeover pre/setup time in hours

": "{Decimal}",
28
                         "cleanupTime
CleanupTime

Changeover post/cleanup time in hours

": "{Decimal}"
29
                    }
30
               },
31
               "aggregatedProductionTimes": {
32
                    "numberOfCompletedProductionWorkOrders
NumberOfCompletedProductionWorkOrders

Numbers of completed production work orders

": "{Integer}",
33
                    "processing": {
34
                         "averageRunTime
AverageRunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}",
35
                         "shortestRunTime
ShortestRunTime

Shortest run time out of all completed work order operations taken into average times calculation

": "{Decimal}",
36
                         "longestRunTime
LongestRunTime

Longest run time out of all completed work order operations taken into average times calculation

": "{Decimal}",
37
                         "deviationRunTime
DeviationRunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}"
38
                    },
39
                    "changeover": {
40
                         "setup": {
41
                              "averageSetupTime
AverageSetupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}",
42
                              "shortestSetupTime
ShortestSetupTime

Shortest setup time out of all completed work order operations taken into average times calculation

": "{Decimal}",
43
                              "longestSetupTime
LongestSetupTime

Longest setup time out of all completed work order operations taken into average times calculation

": "{Decimal}",
44
                              "deviationSetupTime
DeviationSetupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}"
45
                         },
46
                         "cleanup": {
47
                              "averageCleanupTime
AverageCleanupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}",
48
                              "shortestCleanupTime
ShortestCleanupTime

Shortest cleanup time out of all completed work order operations taken into average times calculation

": "{Decimal}",
49
                              "longestCleanupTime
LongestCleanupTime

Longest cleanup time out of all completed work order operations taken into average times calculation

": "{Decimal}",
50
                              "deviationCleanupTime
DeviationCleanupTime

The time required to process a piece or lot at a specific operation. Specified in hours.

": "{Decimal}"
51
                         }
52
                    }
53
               }
54
          }
55
     ],
56
     "paging
Paging

Detailed paging information for this list.

": {
57
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
60
          "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}",
61
          "firstPage
FirstPage

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

": "{String}",
62
          "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}",
63
          "previousPage
PreviousPage

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

": "{String}",
64
          "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}",
65
          "nextPage
NextPage

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

": "{String}",
66
          "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}",
67
          "lastPage
LastPage

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

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

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

": "{Integer}"
69
     }
70
}

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: