Jump to

• Request
• Response

Check out the structure header attachment

post

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/action/checkOut

Checks out the structure header attachment and marks it as locked for other users.

Request

Path Parameters

• BillSequenceId(required): integer
  Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
• StructureAttachmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Structure Attachments List of Values resource and used to uniquely identify an instance of Item Structure Attachments List of Values. The client should not generate the hash key value. Instead, the client should query on the Item Structure Attachments List of Values collection resource in order to navigate to a specific instance of Item Structure Attachments List of Values to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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

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
  Value that displays the outcome of the checkout custom action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Value that displays the outcome of the checkout custom action."
        }
    },
    "additionalProperties":false
}

Back to Top