Create publish data jobs
post
/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/PublishData
Request
Path Parameters
-
PlanId(required): integer(int64)
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=
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
-
AppendParentJobIdFlag: boolean
Contains one of the following values: true or false. If true, then the ID of the parent scheduled process job is appended to the name of the publish data file. If false, then the ID of the parent scheduled process job isn't appended. The default value is false.
-
EndDate: string
(date-time)
Date and time when the scheduled process completed.
-
ESSJobId: integer
(int64)
Value that uniquely identifies the scheduled process.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process.
-
ExecutionUser: string
Maximum Length:
64
Login that the user used when launching the process. -
Message: string
Text of the error message, if any, that occurred when running the scheduled process.
-
PlanAction: integer
(int32)
Plan action that calls the scheduled process. Value for the publish data action is 7.
-
PlanId: integer
Value that uniquely identifies the plan.
-
PublishStatus: integer
(int32)
Status of the plan. 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.
-
StartDate: string
(date-time)
Date and time when the scheduled process started.
-
SubmissionNotes: string
Comments associated with the scheduled process that's submitted.
-
TableName: string
Name of the pivot table that's used to publish plan data.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : supplyChainPlans-PublishData-item-response
Type:
Show Source
object
-
AppendParentJobIdFlag: boolean
Contains one of the following values: true or false. If true, then the ID of the parent scheduled process job is appended to the name of the publish data file. If false, then the ID of the parent scheduled process job isn't appended. The default value is false.
-
EndDate: string
(date-time)
Date and time when the scheduled process completed.
-
ESSJobId: integer
(int64)
Value that uniquely identifies the scheduled process.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process.
-
ExecutionUser: string
Maximum Length:
64
Login that the user used when launching the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Text of the error message, if any, that occurred when running the scheduled process.
-
PlanAction: integer
(int32)
Plan action that calls the scheduled process. Value for the publish data action is 7.
-
PlanId: integer
Value that uniquely identifies the plan.
-
PublishStatus: integer
(int32)
Status of the plan. 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.
-
StartDate: string
(date-time)
Date and time when the scheduled process started.
-
SubmissionNotes: string
Comments associated with the scheduled process that's submitted.
-
TableName: string
Name of the pivot table that's used to publish plan data.
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 publish data jobs.
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/supplyChainPlans/300100543809995/child/PublishData""
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/supplyChainPlans/300100543809995/child/PublishData"
Example Request Body
The following example includes the contents of the request body in JSON format.
{ "TableName":"Material Plan" }
Example Response Body
The following example includes the contents of the response body in
JSON format:
{ "PlanId": 300100543809995, "ExecutionId": 300100543806257, "PublishStatus": null, "ESSJobId": 82978, "StartDate": null, "EndDate": null, "ExecutionUser": "SCMOPERATIONS", "PlanAction": 7, "Message": "", "TableName": "Material Plan", "SubmissionNotes": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995/child/PublishData/300100543806257", "name": "PublishData", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995/child/PublishData/300100543806257", "name": "PublishData", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995", "name": "supplyChainPlans", "kind": "item" } ] }