Jump to

• Request
• Response

Generate KPI values for metrics on the landing page

post

/fscmRestApi/resources/11.13.18.05/processWorkOrders/action/workOrderLandingPageMetrics

Generates the KPI values for metrics on the landing page.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• metric: string
  The name of the KPI metric in the landing page.
• organizationId: number
  Value that uniquely Identifies the organization.
• workAreaId: number
  Value that uniquely identifies the work area.
• workCenterId: number
  Value that uniquely identifies the work center.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"number",
            "description":"Value that uniquely Identifies the organization.",
            "nullable":true
        },
        "metric":{
            "type":"string",
            "description":"The name of the KPI metric in the landing page.",
            "nullable":true
        },
        "workCenterId":{
            "type":"number",
            "description":"Value that uniquely identifies the work center.",
            "nullable":true
        },
        "workAreaId":{
            "type":"number",
            "description":"Value that uniquely identifies the work area.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The value of the metric returned after the action completed successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The value of the metric returned after the action completed successfully."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The value of the metric returned after the action completed successfully."
}

The value of the metric returned after the action completed successfully.

Back to Top