GET production/resources/usage-by-date

Showing usage and capacity for all active production resources

Note: Log in to check if your API client have access to run this resource
Version: 4
Success HTTP Status Code: 200
Maximum items from list ($top): 1000

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

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

Date Datetime Resource capacity/allocation date. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductionResourceGroupId Integer Parent group of the resource.
ProductionResourceId Integer Production resource identifier.
ProductionResourceType String Defines the CLASS of the resource.

See the page about filters and sorting on how to use sortable parameters

Date Datetime Resource capacity/allocation date.
ProductionResourceGroupId Integer Parent group of the resource
ProductionResourceId Integer Production resource identifier
ProductionResourceType String Defines the CLASS of the resource.

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
<ProductionResourcesUsages>
2
     <ProductionResourceUsage>
3
          <ProductionResource>
4
               <ProductionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here when logged in

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

Name of production resource

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

Short name of production resource

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

Description of production resource

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

Defines the CLASS of the resource.

Possible domain values can be found here when logged in

>
{String}</Type>
10
               <ProductionResourceGroup>
11
                    <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

Production resource group reference

>
{String}</ProductionResourceGroupLink>
14
               </ProductionResourceGroup>
15
               <ProductionResourceLink
ProductionResourceLink

Production resource reference

>
{String}</ProductionResourceLink>
16
          </ProductionResource>
17
          <UsageLastFourWeeks>
18
               <Usage>
19
                    <Date
Date

Resource capacity/allocation date.

>
{Datetime}</Date>
20
                    <TotalHours>
21
                         <Available
Available

Free hours (not allocated) capacity for the date.

>
{Decimal}</Available>
22
                         <Assigned
Assigned

Total used hours for the date.

>
{Decimal}</Assigned>
23
                         <AssignedToActiveWorkOrders
AssignedToActiveWorkOrders

Hours reserved by released production work orders for the date.

>
{Decimal}</AssignedToActiveWorkOrders>
24
                         <AssignedToPlannedWorkOrders
AssignedToPlannedWorkOrders

Hours reserved for planned but not released production work orders for the date.

>
{Decimal}</AssignedToPlannedWorkOrders>
25
                         <Capacity
Capacity

Resource day (per date) capacity in hours.

>
{Decimal}</Capacity>
26
                    </TotalHours>
27
               </Usage>
28
          </UsageLastFourWeeks>
29
     </ProductionResourceUsage>
30
</ProductionResourcesUsages>
1
{
2
     "productionResourcesUsages": [
3
          {
4
               "productionResource": {
5
                    "productionResourceId
ProductionResourceId

Production resource identifier

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

Status of production resource

Possible domain values can be found here when logged in

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

Name of production resource

":
"{String}",
8
                    "shortName
ShortName

Short name of production resource

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

Description of production resource

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

Defines the CLASS of the resource.

Possible domain values can be found here when logged in

":
"{String}",
11
                    "productionResourceGroup": {
12
                         "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

":
"{String}",
14
                         "productionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

":
"{String}"
15
                    },
16
                    "productionResourceLink
ProductionResourceLink

Production resource reference

":
"{String}"
17
               },
18
               "usageLastFourWeeks": [
19
                    {
20
                         "date
Date

Resource capacity/allocation date.

":
"{Datetime}",
21
                         "totalHours": {
22
                              "available
Available

Free hours (not allocated) capacity for the date.

":
"{Decimal}",
23
                              "assigned
Assigned

Total used hours for the date.

":
"{Decimal}",
24
                              "assignedToActiveWorkOrders
AssignedToActiveWorkOrders

Hours reserved by released production work orders for the date.

":
"{Decimal}",
25
                              "assignedToPlannedWorkOrders
AssignedToPlannedWorkOrders

Hours reserved for planned but not released production work orders for the date.

":
"{Decimal}",
26
                              "capacity
Capacity

Resource day (per date) capacity in hours.

":
"{Decimal}"
27
                         }
28
                    }
29
               ]
30
          }
31
     ]
32
}

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 100207 HTTP 404 Production resource not found
Error 103366 HTTP 404 Production resource group not found.
Error 104884 HTTP 400 Number of resources X number of days can not be more than 1100.
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 100048 HTTP 400 Parameter {0}: {1} not valid
Error 101514 HTTP 400 Setting definition reference is required
Error 101708 HTTP 400 Default value is required
Error 101640 HTTP 400 Data type is required
Error 101015 HTTP 404 Permission not found