1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Demand Plans
  5. Runs

Get one run

get

/fscmRestApi/resources/11.13.18.05/demandPlans/{PlanId}/child/Runs/{ExecutionId}

Request

Path Parameters
  • 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=
  • 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=
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : demandPlans-Runs-item-response
Type: object
Show Source
  • Contains one of the following values: true or false. If true, then archive the plan before the next plan run. If false, then don't archive. The default value is false. Note that you can archive a plan only if you enable it for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
  • Contains one of the following values: true or false. If true, then include details of the causal factors that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the causal factor group creates.
  • Date and time when the plan run completed.
  • Value that uniquely identifies the process.
  • Maximum Length: 64
    Login that the user used when launching the process.
  • Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.
  • Contains one of the following values: 1 or 2. If 1, then include the forecast bookings profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
  • Contains one of the following values: true or false. If true, then include details of the forecast methods that make up the forecast. If false, then don't provide these details. You must set this attribute to true to view the forecast details that the forecast method creates.
  • List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • Contains one of the following values: 1 or 2. If 1, then include the forecast shipments profile when running the plan. If 2, then don't include this profile. You must include the forecast bookings profile or the forecast shipments profile when you run the forecast process.
  • Value that uniquely identifies the scheduled process.
  • Links
  • Text of the error messages, if any, that occurred when running the scheduled process.
  • Specifies whether data is to be refreshed or not. Contains one of the following values: 1, 2 or 3. If 1, then all data is refreshed. If 2, then only selected entities are refreshed. If 3, then data isn't refreshed.
  • Value that uniquely identifies the plan.
  • Date and time to start the scheduled process.
  • Status of the plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
Back to Top

Examples

This example describes how to get one run.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/demandPlans/PlanId/child/Runs/ExecutionId"

For example, the following command gets one run:

curl -u username:password "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784/child/Runs/300100071618789"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "PlanId": 300100071618784,
    "ExecutionId": 300100071618789,
    "Status": 0,
    "JobId": 6023,
    "StartDate": "2015-11-30T12:45:04.425+00:00",
    "EndDate": "2015-11-30T13:00:52.902+00:00",
    "ExecutionUser": "APS_ALL",
    "Mode": null,
    "ArchivePlanFlag": null,
    "Message": null,
    "ForecastMethodsFlag": null,
    "CausalFactorsFlag": null,
    "ForecastBookingsFlag": null,
    "ForecastShipmentsFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784/child/Runs/300100071618789",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784/child/Runs/300100071618789",
            "name": "Runs",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/demandPlans/300100071618784",
            "name": "demandPlans",
            "kind": "item"
        }
    ]
}
Back to Top