Jump to

• Request
• Response
• Examples

Get Collaborative Quote Queue

get

/rest/v19/collabOperationQueues/{bsId}

Use this endpoint to retrieve queued tasks for the specified transaction.

Request

Path Parameters

• bsId(required): integer

Back to Top

Response

Supported Media Types

• application/json

Default Response

A snapshot of the state of the collab operation queue at the time that the request is processed.

Body ()

Root Schema : Collab operation queue state

Type: object

Title: Collab operation queue state

A snapshot of the state of the queue. It represents the state at a single instant, and might not be accurate at any time after that instant.

Show Source

• currentlyExecutingOperation: array Currently executing operation
  Title: Currently executing operation

  Operation which is currently executing. Omitted if the next queued operation has not started executing yet.
• node: string
  Title: node

  Name of the node that is currently responsible for executing all operations for the bsId.
• operationCount: integer
  Title: Operations count

  The total number of incomplete operations, including executing and queued operations.
• queuedOperations: array Queued operations
  Title: Queued operations

  Operations which are queued and have not started execution. The order of the items in the array is the order in which they will execute.

{
    "type":"object",
    "properties":{
        "queuedOperations":{
            "type":"array",
            "description":"Operations which are queued and have not started execution. The order of the items in the array is the order in which they will execute.",
            "title":"Queued operations",
            "items":{
                "$ref":"#/definitions/operation"
            }
        },
        "currentlyExecutingOperation":{
            "type":"array",
            "description":"Operation which is currently executing. Omitted if the next queued operation has not started executing yet.",
            "title":"Currently executing operation",
            "items":{
                "$ref":"#/definitions/operation"
            }
        },
        "node":{
            "type":"string",
            "description":"Name of the node that is currently responsible for executing all operations for the bsId.",
            "title":"node"
        },
        "operationCount":{
            "type":"integer",
            "description":"The total number of incomplete operations, including executing and queued operations.",
            "title":"Operations count"
        }
    },
    "title":"Collab operation queue state",
    "description":"A snapshot of the state of the queue. It represents the state at a single instant, and might not be accurate at any time after that instant."
}

Nested Schema : Currently executing operation

Type: array

Title: Currently executing operation

Operation which is currently executing. Omitted if the next queued operation has not started executing yet.

Show Source

• Array of: object Collab queue operation properties
  Title: Collab queue operation properties

{
    "type":"array",
    "description":"Operation which is currently executing. Omitted if the next queued operation has not started executing yet.",
    "title":"Currently executing operation",
    "items":{
        "$ref":"#/definitions/operation"
    }
}

Nested Schema : Queued operations

Type: array

Title: Queued operations

Operations which are queued and have not started execution. The order of the items in the array is the order in which they will execute.

Show Source

• Array of: object Collab queue operation properties
  Title: Collab queue operation properties

{
    "type":"array",
    "description":"Operations which are queued and have not started execution. The order of the items in the array is the order in which they will execute.",
    "title":"Queued operations",
    "items":{
        "$ref":"#/definitions/operation"
    }
}

Nested Schema : Collab queue operation properties

Type: object

Title: Collab queue operation properties

Show Source

• description: string
  Title: Description

  Description of the operation. This is only intended for human consumption and its format may change at any time.
• submissionTime: string
  Title: Submission time

  Approximate time when the operation was submitted, in ISO8601 format. This is NOT used to determine the ordering of operations within the queue.
• submitterCompanyName: string
  Title: Submitter company name

  Company name of the user who submitted the operation.
• submitterLoginName: string
  Title: Submitter login name

  Login name of the user who submitted the operation.
• uuid: string
  Title: Operation uuid

  Unique identifier of the operation.

{
    "type":"object",
    "properties":{
        "uuid":{
            "type":"string",
            "description":"Unique identifier of the operation.",
            "title":"Operation uuid"
        },
        "submitterLoginName":{
            "type":"string",
            "description":"Login name of the user who submitted the operation.",
            "title":"Submitter login name"
        },
        "submitterCompanyName":{
            "type":"string",
            "description":"Company name of the user who submitted the operation.",
            "title":"Submitter company name"
        },
        "submissionTime":{
            "type":"string",
            "description":"Approximate time when the operation was submitted, in ISO8601 format. This is NOT used to determine the ordering of operations within the queue.",
            "title":"Submission time"
        },
        "description":{
            "type":"string",
            "description":"Description of the operation. This is only intended for human consumption and its format may change at any time.",
            "title":"Description"
        }
    },
    "title":"Collab queue operation properties"
}

Back to Top

Examples

The following example shows how to retrieve queued tasks for the specified transaction by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/collabOperationQueues/30221276251

Response Body Sample

{
  "queuedOperations": [{
    "uuid": "eaf67e0f-65fc-4ecc-8bfd-09a3dd9c82c0",
    "submitterLoginName": "alex",
    "submitterCompanyName": "mumbai54488",
    "submissionTime": "2024-03-14T09:54:07.649Z",
    "description": "ResourceCmActionOperation[docNum=1,actionVarName=_open_main]"
  }, {
    "uuid": "4bbd4008-aed7-4cc1-b616-6d1ebcd2fbeb",
    "submitterLoginName": "alex",
    "submitterCompanyName": "mumbai54488",
    "submissionTime": "2024-03-14T09:54:09.798Z",
    "description": "ResourceCmActionOperation[docNum=1,actionVarName=_open_main]"
  }],
  "currentlyExecutingOperation": {
    "uuid": "6cc3a88c-4921-4b21-95de-2709d44cf8d5",
    "submitterLoginName": "alex",
    "submitterCompanyName": "mumbai54488",
    "submissionTime": "2024-03-14T09:54:02.593Z",
    "description": "ResourceCmActionOperation[docNum=1,actionVarName=test_c]"
  },
  "operationCount": 3,
  "node": "node1"
}

Error Responses

400 - Collaborative quote editing is not enabled for process

403 - User with restricted access (Sales agent etc)

404 - Invalid bsId provided in the endpoint

Back to Top