Create runs
post
/fscmRestApi/resources/11.13.18.05/backlogManagementPlans/{BmRunId}/child/runs
Request
Path Parameters
-
BmRunId(required): integer
Value that uniquely identifies the backlog management plan run.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BmRunId: integer
(int64)
Value that uniquely identifies the backlog management plan run.
-
Category: string
Item category whose demands must be planned.
-
CreatedBy: string
Maximum Length:
64
User who created the backlog management plan run. -
CreationDate: string
(date-time)
Date when the user created the demand.
-
Customer: string
Customer whose demands must be planned.
-
DemandPriorityRule: string
Demand priority rule used by the backlog management plan run.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process of the backlog management run.
-
InstanceCode: string
Maximum Length:
255
Value that uniquely identifies the application instance or the source system code for which the backlog plan is run. -
Item: string
Item whose demands must be planned.
-
LastUpdateDate: string
(date-time)
Date when the user most recently updated the data within the backlog management plan run.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the data in the backlog management plan run. -
LastUpdateLogin: string
Maximum Length:
32
Login of the user who most recently updated the backlog management plan run. -
Organization: string
Organization whose demands must be planned.
-
PercentageCompleted: integer
Percent completion of the backlog management plan run.
-
RefreshSupplyChainData: string
Value that indicates whether relationships between items must be determined. Valid values include True to indicate that relationships must be recalculated and False to indicate they should not be.
-
Status: integer
Status of the backlog management plan run. Valid values include 1 for success and 2 for failure.
-
Step: integer
Value that identifies the step of the backlog management plan run. There are 10 steps.
-
StepSequence: integer
Step of the backlog management plan run that has been completed.
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.
Root Schema : backlogManagementPlans-runs-item-response
Type:
Show Source
object
-
BmRunId: integer
(int64)
Value that uniquely identifies the backlog management plan run.
-
Category: string
Item category whose demands must be planned.
-
CreatedBy: string
Maximum Length:
64
User who created the backlog management plan run. -
CreationDate: string
(date-time)
Date when the user created the demand.
-
Customer: string
Customer whose demands must be planned.
-
DemandPriorityRule: string
Demand priority rule used by the backlog management plan run.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process of the backlog management run.
-
InstanceCode: string
Maximum Length:
255
Value that uniquely identifies the application instance or the source system code for which the backlog plan is run. -
Item: string
Item whose demands must be planned.
-
LastUpdateDate: string
(date-time)
Date when the user most recently updated the data within the backlog management plan run.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the data in the backlog management plan run. -
LastUpdateLogin: string
Maximum Length:
32
Login of the user who most recently updated the backlog management plan run. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Organization: string
Organization whose demands must be planned.
-
PercentageCompleted: integer
Percent completion of the backlog management plan run.
-
RefreshSupplyChainData: string
Value that indicates whether relationships between items must be determined. Valid values include True to indicate that relationships must be recalculated and False to indicate they should not be.
-
Status: integer
Status of the backlog management plan run. Valid values include 1 for success and 2 for failure.
-
Step: integer
Value that identifies the step of the backlog management plan run. There are 10 steps.
-
StepSequence: integer
Step of the backlog management plan run that has been completed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create runs.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/backlogManagementPlans/BmRunId/child/runs"For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/runs"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "DemandPriorityRule": null, "InstanceCode": "BLM", "Organization": "BLM:BLM_M1,BLM:BLM_M2", "Category": null, "Item": null, "Customer": null }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ExecutionId": 176356, "BmRunId": null, "Step": null, "Status": null, "CreatedBy": null, "CreationDate": null, "LastUpdateDate": null, "LastUpdatedBy": null, "LastUpdateLogin": null, "PercentageCompleted": null, "StepSequence": null, "DemandPriorityRule": null, "Organization": "BLM:BLM_M1,BLM:BLM_M2", "Category": null, "Item": null, "Customer": null, "RefreshSupplyChainData": null, "InstanceCode": "BLM", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/runs/176356", "name": "runs", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/runs/176356", "name": "runs", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1", "name": "backlogManagementPlans", "kind": "item" } ] }