Jump to

• Request
• Response

Get one resource utilization value

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceUtilization/{resourceUtilizationUniqID}

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• resourceUtilizationUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, WorkCenterId, ResourceId, BucketType and BucketStartDate ---for the Resource Utilization resource and used to uniquely identify an instance of Resource Utilization. The client should not generate the hash key value. Instead, the client should query on the Resource Utilization collection resource with a filter on the primary key values in order to navigate to a specific instance of Resource Utilization.
  
  For example: resourceUtilization?q=PlanId=<value1>;WorkCenterId=<value2>;ResourceId=<value3>;BucketType=<value4>;BucketStartDate=<value5>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productionSchedulingPlans-resourceUtilization-item-response

Type: object

Show Source

• BucketStartDate: string (date-time)
  Read Only: true

  Date when the bucket for resource utilization calculations is effective.
• BucketType: string
  Read Only: true

  Maximum Length: 32

  Type of bucket of resource utilization data. Valid values include daily or weekly.
• CapacityType: string
  Read Only: true

  Maximum Length: 30

  Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.
• ChangeoverHours: number
  Read Only: true

  Number of hours taken for a changeover.
• ChangeoverPercentage: number
  Read Only: true

  Percentage of time taken for changeovers.
• DelayHours: number
  Read Only: true

  Number of hours taken by delay time.
• DelayPercentage: number
  Read Only: true

  Percentage of time taken for delays.
• DownHours: number
  Read Only: true

  Number of hours taken by down time.
• DownPercentage: number
  Read Only: true

  Percentage of time taken for down time.
• IdleHours: number
  Read Only: true

  Number of hours the resource is idle.
• IdlePercentage: number
  Read Only: true

  Percentage of time taken for idle time.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCapacity: number
  Read Only: true

  Maximum capacity of the resource.
• NetAvailableHours: number
  Read Only: true

  Number of net available hours of the resource.
• PlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production schedule.
• ResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production resource. It's a primary key of the resource.
• ResourceType: string
  Read Only: true

  Maximum Length: 30

  Type of production resource. Valid values include Equipment or Labor.
• RunHours: number
  Read Only: true

  Number of hours taken to preform a task.
• RunPercentage: number
  Read Only: true

  Percentage of time used to perform a task.
• TotalAvailableHours: number
  Read Only: true

  Number of total available hours of the resource.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IdleHours":{
            "type":"number",
            "description":"Number of hours the resource is idle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAvailableHours":{
            "type":"number",
            "description":"Number of total available hours of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RunPercentage":{
            "type":"number",
            "description":"Percentage of time used to perform a task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCapacity":{
            "type":"number",
            "description":"Maximum capacity of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of production resource. Valid values include Equipment or Labor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayPercentage":{
            "type":"number",
            "description":"Percentage of time taken for delays.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeoverPercentage":{
            "type":"number",
            "description":"Percentage of time taken for changeovers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BucketType":{
            "maxLength":32,
            "type":"string",
            "description":"Type of bucket of resource utilization data. Valid values include daily or weekly.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetAvailableHours":{
            "type":"number",
            "description":"Number of net available hours of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownPercentage":{
            "type":"number",
            "description":"Percentage of time taken for down time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayHours":{
            "type":"number",
            "description":"Number of hours taken by delay time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CapacityType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeoverHours":{
            "type":"number",
            "description":"Number of hours taken for a changeover.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdlePercentage":{
            "type":"number",
            "description":"Percentage of time taken for idle time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownHours":{
            "type":"number",
            "description":"Number of hours taken by down time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BucketStartDate":{
            "type":"string",
            "description":"Date when the bucket for resource utilization calculations is effective.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RunHours":{
            "type":"number",
            "description":"Number of hours taken to preform a task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top