Jump to

• Request
• Response

Submit a correction or return for approval

post

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/action/submitForApproval

Submits a receiving correction or return for approval. The approval workflow is triggered for a correction or return if approvals are setup for these transactions.

Request

Path Parameters

• HeaderInterfaceId(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: 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

Show Source

• GroupId: number
  A value that uniquely identifies the group of interface records submitted together for processing.
• OrganizationId: number
  Value that uniquely identifies the receiving organization.
• TransactionDisplayValue: string
  The name that uniquely identifies the receiving correction or return that's submitted for approval.
• TransactionKey: number
  A value that uniquely identifies the receiving correction or return that's submitted for approval.
• TransactionType: string
  A value that uniquely identifies the receiving transaction type. The valid values include CORRECT, SSP_CORRECT, and SSP_RETURN.

{
    "type":"object",
    "properties":{
        "TransactionDisplayValue":{
            "type":"string",
            "description":"The name that uniquely identifies the receiving correction or return that's submitted for approval.",
            "nullable":true
        },
        "TransactionType":{
            "type":"string",
            "description":"A value that uniquely identifies the receiving transaction type. The valid values include CORRECT, SSP_CORRECT, and SSP_RETURN.",
            "nullable":true
        },
        "TransactionKey":{
            "type":"number",
            "description":"A value that uniquely identifies the receiving correction or return that's submitted for approval.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the receiving organization.",
            "nullable":true
        },
        "GroupId":{
            "type":"number",
            "description":"A value that uniquely identifies the group of interface records submitted together for processing.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  If the request is successful, this action returns SUCCESS.

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

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"If the request is successful, this action returns SUCCESS."
}

If the request is successful, this action returns SUCCESS.

Back to Top