Jump to

• Request
• Response
• Examples

Close one schedule

post

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/action/close

Closes the purchase order schedule according to the close action. Close actions include close for receiving, close for invoicing, close, and finally close. When manually closing, a check for allowable close statuses will be performed at the schedule level. Close actions will roll up to higher levels. Once all schedules for a given line are closed, the line is closed.

Request

Path Parameters

• POLineId(required): integer(int64)
  Value that uniquely identifies the purchase order line.
• purchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
• schedulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Schedules resource and used to uniquely identify an instance of Schedules. The client should not generate the hash key value. Instead, the client should query on the Schedules collection resource in order to navigate to a specific instance of Schedules to get the hash key.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• closeAction: string
  Value that indicates the close action. Valid values include closeForReceiving, closeForInvoicing, close, or finallyClose. This attribute doesn't have a default value.
• closeReason: string
  Value that indicates the reason for closing the purchase order schedule. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "closeAction":{
            "type":"string",
            "description":"Value that indicates the close action. Valid values include closeForReceiving, closeForInvoicing, close, or finallyClose. This attribute doesn't have a default value.",
            "nullable":true
        },
        "closeReason":{
            "type":"string",
            "description":"Value that indicates the reason for closing the purchase order schedule. This attribute doesn't have a default value.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, then this action returns a value of Success.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a value of Success."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to create one component.

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

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

Example Request Body

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

Example Response Body

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

Back to Top