Jump to

• Request
• Response
• Examples

Copy Sequence

post

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/actions/_copy_sequence

Use this endpoint to retrieve copy sequences for the Commerce process.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• Stage(required): string
  The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)

Body ()

Root Schema : Transaction-_copy_sequenceCollectionRequest

Type: object

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_copy_sequenceCollectionResponse

Type: object

Show Source

• sequences: array sequences
  Title: sequences

  sequences

{
    "type":"object",
    "properties":{
        "sequences":{
            "$ref":"#/definitions/sequencesDef"
        }
    }
}

Nested Schema : sequences

Type: array

Title: sequences

sequences

Show Source

• Array of: object sequenceDef
  Title: sequenceDef

  sequenceDef

{
    "title":"sequences",
    "type":"array",
    "description":"sequences",
    "items":{
        "$ref":"#/definitions/sequenceDef"
    }
}

Nested Schema : sequenceDef

Type: object

Title: sequenceDef

sequenceDef

Show Source

• description: string
  Description for the sequence
• id: integer
  Id for the sequence
• modifiedDate: string
• name: string
  Name of the sequence
• order: integer
  Order of sequence

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Id for the sequence"
        },
        "order":{
            "type":"integer",
            "description":"Order of sequence"
        },
        "name":{
            "type":"string",
            "description":"Name of the sequence"
        },
        "description":{
            "type":"string",
            "description":"Description for the sequence"
        },
        "modifiedDate":{
            "type":"string"
        }
    },
    "title":"sequenceDef",
    "description":"sequenceDef"
}

Back to Top

Examples

The following example shows how to retrieve copy sequences for the Commerce process by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_copy_sequence

Response Body Sample

{
  "sequences": [{
      "name": "sequence 1",
      "id": 38736650,
      "order": 1,
      "description": "",
      "modifiedDate": "Mon May 06 21:55:11 UTC 2024"
    }
  ]
}

Back to Top