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

Get one duplicate

get

/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/Duplicates/{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 : supplyChainPlans-Duplicates-item-response
Type: object
Show Source
  • Determines the plan data to copy. Valid values include 1: copy only plan options, 2: copy plan with reference to base plan, or 3: copy all plan data with no reference to base plan. The default value is 2. A list of accepted values is defined in the lookup type ORA_MSC_COPY_PLAN_TYPES.
  • Status of the scheduled process that duplicates the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.
  • Date and time when the scheduled process finished running.
  • Value that uniquely identifies the scheduled process.
  • Value that uniquely identifies the scheduled process.
  • Maximum Length: 64
    Sign in that the user used when starting the scheduled process.
  • Contains one of the following values: true or false. If true, then include archives when copying plan data without a reference to base plan. If false, then don't copy archives. The default value is false.
  • Links
  • Contains one of the following values: true or false. If true, then load the plan after the copy finishes. If false, then don't load. The default value is false.
  • Text of the error message that occurred when running the scheduled process.
  • Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. The default value is 1. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS.
  • List of users granted access to the new plan that the duplication process created. A comma separates each value.
  • Description of the new plan that the duplication process creates.
  • Value that uniquely identifies the new plan that the duplication process creates.
  • Maximum Length: 255
    List of users granted restricted access to a plan that the duplication process created. A comma separates each value.
  • Name of the new plan that the duplication process creates.
  • Owner of the new plan that the duplication process creates.
  • Plan action that calls the scheduled process. Value for duplicate action is 4: duplicate.
  • Value that uniquely identifies the plan.
  • Date and time when the scheduled process started to run.
Back to Top

Examples

This example describes how to get one plan copy detail.

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/supplyChainPlans/PlanId/child/Duplicates/ExecutionId"

Example Response Body

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

{
    "PlanId": 300100075800997,
    "ExecutionId": 300100141407656,
    "DuplicateStatus": 3,
    "ESSJobId": 117431,
    "StartDate": "2018-03-14T20:33:57.403+00:00",
    "EndDate": "2018-03-14T20:36:35.886+00:00",
    "ExecutionUser": "john",
    "PlanAction": 4,
    "NewPlanName": null,
    "NewPlanDescription": null,
    "NewPlanOwner": null,
    "NewPlanAccessType": null,
    "NewPlanAccessUsers": null,
    "NewPlanId": null,
    "CopyPlanType": null,
    "LoadPlanAfterCopy": null,
    "Message": "", ...
}
Back to Top