Jump to

• Request
• Response
• Examples

Submit prepare plan for buyer planning scheduled process

post

/fscmRestApi/resources/11.13.18.05/buyerPlanningSupplies/buyerPlanningSupplies/preparePlan

Submit prepare plan for buyer planning scheduled process.

Request

Header Parameters

• 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 doesn't specify this header in the request the server picks a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanName: string
  Name of the Plan.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "PlanName":{
            "type":"string",
            "description":"Name of the Plan."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : buyerPlanningSupplies-preparePlanItem-response

Type: object

Show Source

• Status: string
  Title: Status

  Submit Prepare Plan for Buyer Planning scheduled process.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"Submit Prepare Plan for Buyer Planning scheduled process."
        }
    }
}

Back to Top

Examples

This example describes how to submit a prepare plan for the buyer planning scheduled process.

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/buyerPlanningSupplies/preparePlan"

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 updates.

{
  "PlanId": 300100573650379,
  "PlanName": "SCC-HC-Repl-Plan1"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "Status": "PreparePlan check process completed"
}

Back to Top