Jump to

• Request
• Response
• Examples

Forward Transactions

post

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_forward

Use this endpoint to forward selected transactions to the specified users and/or groups.

Request

Supported Media Types

• application/json

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-_forwardCollectionRequest

Type: object

Show Source

• company: string
  Title: Company

  The company name
• ids: array The transaction ids
  Title: The transaction ids

  The list of transactions that are forwarded to user/groups
• salesGroups: object Sales Groups
  Title: Sales Groups
• salesUsers: object Sales Users
  Title: Sales Users

{
    "type":"object",
    "properties":{
        "salesGroups":{
            "$ref":"#/definitions/salesGroups"
        },
        "ids":{
            "$ref":"#/definitions/ids"
        },
        "company":{
            "type":"string",
            "description":"The company name",
            "title":"Company"
        },
        "salesUsers":{
            "$ref":"#/definitions/salesUsers"
        }
    }
}

Nested Schema : The transaction ids

Type: array

Title: The transaction ids

The list of transactions that are forwarded to user/groups

Show Source

• Array of: number

{
    "title":"The transaction ids",
    "type":"array",
    "description":"The list of transactions that are forwarded to user/groups",
    "items":{
        "type":"number"
    }
}

Nested Schema : Sales Groups

Type: object

Title: Sales Groups

Show Source

• label: string
  Title: Group Label

  Label of the group.
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  The identifier for a sales group.
• variableName: string
  Title: Group Variable Name

  Variable Name of the group.

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"The identifier for a sales group.",
            "title":"Id"
        },
        " label":{
            "type":"string",
            "description":"Label of the group.",
            "title":"Group Label"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the group.",
            "title":"Group Variable Name"
        }
    },
    "title":"Sales Groups"
}

Nested Schema : Sales Users

Type: object

Title: Sales Users

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• email: string
  Title: Email Address

  Email address of the user
• firstName: string
  Title: First Name

  First Name of the user.
• key: string
  Title: key

  The identifier for the sales user.
• lastName: string
  Title: Last Name

  Last Name of the user

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "email":{
            "type":"string",
            "description":"Email address of the user",
            "title":"Email Address"
        },
        "firstName":{
            "type":"string",
            "description":"First Name of the user.",
            "title":"First Name"
        },
        "key":{
            "type":"string",
            "description":"The identifier for the sales user.",
            "title":"key"
        },
        "lastName":{
            "type":"string",
            "description":"Last Name of the user",
            "title":"Last Name"
        }
    },
    "title":"Sales Users"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-_forwardCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to forward selected transactions to the specified users and/or groups. 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/_forward

Request Body Sample

{
  "ids": [18007731, 18007790, 18005157],
  "company": "company123,
  "salesGroups": [group1, group2, group3],
  "salesUsers": []
}

Back to Top