API

Production APIs

GET system/reports/108782/result-set

Bank Balances and Movements - By Date & Bank

Report name Finished Work Order Operations
Report identifier 108782
HTTP method GET
URI https://api.rambase.net/system/reports/108782/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5233, version 3

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

AccruedRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AccruedSetupTime Decimal Time in hours used for setup changeover.
CleanupTime Decimal Time in hours used for cleanup changeover.
FinishedAt Datetime Date and time of completion. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
LatestOperatorId Integer Employee identifier.
OperationName String Name of production operation.
PlannedCleanupTime Decimal Changeover post/cleanup time in hours.
PlannedRunTime Decimal Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation.
PlannedSetupTime Decimal Changeover pre/setup time in hours.
ProductId Integer Product identifier.
ProductionResourceId Integer Production resource identifier.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
SequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
StartedAt Datetime Date and time work order operation actually started. 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

AccruedRunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
AccruedSetupTime Decimal Time in hours used for setup changeover
CleanupTime Decimal Time in hours used for cleanup changeover
FinishedAt Datetime Date and time of completion
LatestOperatorId Integer Employee identifier
OperationName String Name of production operation
PlannedCleanupTime Decimal Changeover post/cleanup time in hours
PlannedRunTime Decimal Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation
PlannedSetupTime Decimal Changeover pre/setup time in hours
ProductId Integer Product identifier
ProductionResourceId Integer Production resource identifier
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
SequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
StartedAt Datetime Date and time work order operation actually started

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
<Report>
2
     <Rows>
3
          <Row>
4
               <ProductionWorkOrder
ProductionWorkOrder

Production work order reference

>
5
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>
{Integer}</ProductionWorkOrderId>
6
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>
{String}</ProductionWorkOrderLink>
7
               </ProductionWorkOrder>
8
               <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

>
{Integer}</SequenceNumber>
9
               <OperationName
OperationName

Name of production operation

>
{String}</OperationName>
10
               <Product
Product

Product reference

>
11
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>
{String}</ProductLink>
14
               </Product>
15
               <ProductionResource
ProductionResource

Resource reference

>
16
                    <ProductionResourceId
ProductionResourceId

Production resource identifier

>
{Integer}</ProductionResourceId>
17
                    <Name
Name

Name of production resource

>
{String}</Name>
18
                    <ProductionResourceLink
ProductionResourceLink

Production resource reference

>
{String}</ProductionResourceLink>
19
               </ProductionResource>
20
               <LatestOperator
LatestOperator

Latest operator reference

>
21
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
22
                    <LastName
LastName

Last name of employee

>
{String}</LastName>
23
                    <FirstName
FirstName

First name of employee

>
{String}</FirstName>
24
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
25
               </LatestOperator>
26
               <Quantity
Quantity

Produced quantity

>
{Decimal}</Quantity>
27
               <PlannedSetupTime
PlannedSetupTime

Changeover pre/setup time in hours

>
{Decimal}</PlannedSetupTime>
28
               <AccruedSetupTime
AccruedSetupTime

Time in hours used for setup changeover

>
{Decimal}</AccruedSetupTime>
29
               <PlannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

>
{Decimal}</PlannedRunTime>
30
               <AccruedRunTime
AccruedRunTime

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

>
{Decimal}</AccruedRunTime>
31
               <PlannedCleanupTime
PlannedCleanupTime

Changeover post/cleanup time in hours

>
{Decimal}</PlannedCleanupTime>
32
               <CleanupTime
CleanupTime

Time in hours used for cleanup changeover

>
{Decimal}</CleanupTime>
33
               <StartedAt
StartedAt

Date and time work order operation actually started

>
{Datetime}</StartedAt>
34
               <FinishedAt
FinishedAt

Date and time of completion

>
{Datetime}</FinishedAt>
35
               <Inspect>
36
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>
{String}</TargetApplication>
37
                    <Filter
Filter

Filter used when inspecting a line in a report.

>
{String}</Filter>
38
               </Inspect>
39
          </Row>
40
     </Rows>
41
     <Paging
Paging

Detailed paging information for this list.

>
42
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>
{Integer}</Page>
45
          <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>
46
          <FirstPage
FirstPage

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

>
{String}</FirstPage>
47
          <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>
48
          <PreviousPage
PreviousPage

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

>
{String}</PreviousPage>
49
          <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>
50
          <NextPage
NextPage

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

>
{String}</NextPage>
51
          <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>
52
          <LastPage
LastPage

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

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

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

>
{Integer}</Size>
54
     </Paging>
55
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "productionWorkOrder
ProductionWorkOrder

Production work order reference

":
{
6
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

":
"{Integer}",
7
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

":
"{String}"
8
                    },
9
                    "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

":
"{Integer}",
10
                    "operationName
OperationName

Name of production operation

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

Product reference

":
{
12
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

":
"{String}"
15
                    },
16
                    "productionResource
ProductionResource

Resource reference

":
{
17
                         "productionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

":
"{String}",
19
                         "productionResourceLink
ProductionResourceLink

Production resource reference

":
"{String}"
20
                    },
21
                    "latestOperator
LatestOperator

Latest operator reference

":
{
22
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
23
                         "lastName
LastName

Last name of employee

":
"{String}",
24
                         "firstName
FirstName

First name of employee

":
"{String}",
25
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
26
                    },
27
                    "quantity
Quantity

Produced quantity

":
"{Decimal}",
28
                    "plannedSetupTime
PlannedSetupTime

Changeover pre/setup time in hours

":
"{Decimal}",
29
                    "accruedSetupTime
AccruedSetupTime

Time in hours used for setup changeover

":
"{Decimal}",
30
                    "plannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

":
"{Decimal}",
31
                    "accruedRunTime
AccruedRunTime

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

":
"{Decimal}",
32
                    "plannedCleanupTime
PlannedCleanupTime

Changeover post/cleanup time in hours

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

Time in hours used for cleanup changeover

":
"{Decimal}",
34
                    "startedAt
StartedAt

Date and time work order operation actually started

":
"{Datetime}",
35
                    "finishedAt
FinishedAt

Date and time of completion

":
"{Datetime}",
36
                    "inspect": {
37
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

":
"{String}",
38
                         "filter
Filter

Filter used when inspecting a line in a report.

":
"{String}"
39
                    }
40
               }
41
          ]
42
     }
43
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type