# Update DocGen Queue

Update DocGen Queue

Endpoint: PUT /rest/2.0/DOCGEN_QUEUE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.TargetEntityName` (string, required)
    Target Entity Name

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.Status` (string, required)
    Status: Processing Status

  - `brmObjects.ErrorText` (string, required)
    Error Text: Error Text (processing result) from external service

  - `brmObjects.KafkaMessage` (string, required)
    Kafka Message: Prepared Kafka message as JSON - filled only in case it is erquired

  - `brmObjects.TargetEntityObjId` (string, required)
    Target Entity Object Id: ID of object at target entity to store document to

  - `brmObjects.Id` (string, required)
    Id: Primary key

  - `brmObjects.HttpEventId` (string, required)
    HTTP_EVENT ID: Link to HTTP_EVENT when message was sent through Callout

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.TargetEntityField` (string, required)
    Target Entity Field: Field name to store document to

  - `brmObjects.DocGenDocTemplateId` (integer)
    PDF Template: DocGen Document Template

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.TargetEntityName` (string)
    Target Entity Name

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Status` (string)
    Status: Processing Status

  - `retrieveResponse.ErrorText` (string)
    Error Text: Error Text (processing result) from external service

  - `retrieveResponse.KafkaMessage` (string)
    Kafka Message: Prepared Kafka message as JSON - filled only in case it is erquired

  - `retrieveResponse.TargetEntityObjId` (string)
    Target Entity Object Id: ID of object at target entity to store document to

  - `retrieveResponse.Id` (string)
    Id: Primary key

  - `retrieveResponse.HttpEventId` (string)
    HTTP_EVENT ID: Link to HTTP_EVENT when message was sent through Callout

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.TargetEntityField` (string)
    Target Entity Field: Field name to store document to

  - `retrieveResponse.DocGenDocTemplateId` (integer)
    PDF Template: DocGen Document Template

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error