Request

The Request object contains the following properties:

Field	Type	Description
id	string	(Read-only) The primary identifier for the request.
status	string	The status of the request.
client	object	Represents the client accountobject.
vendor	object	Represents the vendor account object
requester	object	The client account user who created the request.
assignee	object	(Optional) The vendor account user responsible for processing the request.
product	object	Represents the product object.
externalIds	object	(Optional) A set of externalID identifiers.
parameters.order	object	(Optional) Values of the orderParameter associated with the request. Example: [ { "id": "PRM-1234-1234-1234-1234", "name": "Tennant Id", "externalId": "tenant_id", "constraints": { ... }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", } ]
error	object	Error reported by validation procedure. Example: { "id": "E001234", "message": "Agreement provisioning failed due to unavailability of the item" }
audit	object	(Read-only) Represents the audit object.

Examples

MINIMAL EXAMPLE

REQUEST OBJECT

{
  "id": "REQ-1671-0642",  
  "status": "Querying",
  "client": { 
    "id": "ACC-1234-4444",
    "name": "Rolls-Royce"
  },
  "vendor": { 
    "id": "ACC-1234-1111",
    "name": "Microsoft"
  },
  "requester": { 
    "id": "USR-1234-4444",
    "name": "John Smith"
  },
  "assignee": { 
    "id": "USR-1234-1111",
    "name": "Santa Claus"
  },
  "product": {
    "id": "PRD-1111-1111-1111",    
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
  }
}

COMPLETE EXAMPLE

REQUEST OBJECT

{
  "id": "REQ-1671-0642",
  "status": "Querying",
  "client": { 
    "id": "ACC-1234-4444",
    "name": "Stark-industries"
  },
  "vendor": { 
    "id": "ACC-1234-1111",
    "name": "Microsoft"
  },
  "requester": { 
    "id": "USR-1234-4444",
    "name": "John Smith"
  },
  "assignee": { 
    "id": "USR-1234-1111",
    "name": "Santa Claus"
  },
  "product": {
    "id": "PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
  },
  "externalIds": {
    "client": "12345678",
    "operations":	"07bf766b-c767-4293-9ab3",
    "vendor": "ABC-2023-C07-dbeee0b302c0"
  },
  "audit": {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}