1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Work Order Metrics

Get all metrics

get

/fscmRestApi/resources/11.13.18.05/workOrdersMetrics

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • WorkOrderOrgAndWorkAreaCenterFilter: Find work order metrics according to organization Id, work area Id, or work center Id.
      Finder Variables:
      • DueDays; integer; Work orders according to days overdue. For example, if DueDays contains 7, then get the work orders that include a scheduled completion date that is greater than the current date minus 7 days.
      • OrganizationId; integer; Primary key that uniquely identifies the organization. Manufacturing generates this primary key when it creates the organization. This attribute is required.
      • Tolerance; integer; Work orders according to overdue work orders. For example, if the tolerance is one hour, then this resource will not return work orders that are one hour or less overdue.
      • WorkAreaId; integer; Primary key that uniquely identifies the work area. Manufacturing generates this primary key when it creates the work area.
      • WorkCenterId; integer; Primary key that uniquely identifies the work center. Manufacturing generates this primary key when it creates the work center.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CompletingToday; number; Number of work orders that are scheduled to finish today, according to your time zone.
    • Delayed; number; Number of work orders that are overdue, according to your time zone and the tolerance for calculating the count of overdue work orders.
    • ExceptionCount; number; Number of open exceptions for work orders.
    • OnHoldCount; number; Number of work orders that are On Hold.
    • OperationDelay; number; Number of work orders that are not overdue but that include one or more delayed operations.
    • StartingToday; number; Number of work orders that are scheduled to start today, according to your time zone.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : workOrdersMetrics
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workOrdersMetrics-item-response
Type: object
Show Source
  • Read Only: true
    Number of work orders that are scheduled to finish today, according to your time zone.
  • Read Only: true
    Number of work orders that are overdue, according to your time zone and the tolerance for calculating the count of overdue work orders.
  • Read Only: true
    Number of open exceptions for work orders.
  • Links
  • Read Only: true
    Number of work orders that are On Hold.
  • Read Only: true
    Number of work orders that are not overdue but that include one or more delayed operations.
  • Read Only: true
    Number of work orders that are scheduled to start today, according to your time zone.
Back to Top

Examples

This example describes how to get all work order metrics.

Example cURL Command

Use the following cURL command to submit a request on the REST resource by using a finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrdersMetrics?finder=WorkOrderOrgAndWorkAreaCenterFilter;OrganizationId=207,DueDays=30,Tolerance=10"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"items": [
	{
		"StartingToday": 15,
		"CompletingToday": 17,
		"Delayed": 86,
		"OnHoldCount": 3,
		"OperationDelay": 1,
		"ExceptionCount": 1,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/workOrdersMetrics/0000",
			"name": "workOrdersMetrics",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/workOrdersMetrics/0000",
			"name": "workOrdersMetrics",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/workOrdersMetrics",
		"name": "workOrdersMetrics",
		"kind": "collection"
	}
	]
}
Back to Top