tickets

Create a ticket

Creates a new ticket.

POST

/v1/tickets

Create a ticket

curl --request POST \
  --url https://api.beamdynamics.io/v1/tickets \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assigneeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "contactEmail": "jsmith@example.com",
  "contactEntityIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "dueDate": "2023-12-25",
  "equipmentsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "equipmentsQty": [
    {
      "equipmentId": "<string>",
      "stockQty": 123
    }
  ],
  "fields": [
    {
      "content": "<string>",
      "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "files": [
    {
      "checksum": "<string>",
      "mimeType": "<string>",
      "name": "<string>",
      "size": "<string>"
    }
  ],
  "locationComment": "<string>",
  "locationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "maintenanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "primaryEquipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "priority": "urgent",
  "shouldReturn": true,
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subStatus": "<string>",
  "ticketTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'

{
  "createdAt": "<string>",
  "description": "<string>",
  "dueDate": "<string>",
  "id": 123,
  "priority": "urgent",
  "seqId": 123,
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ticketTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "updatedAt": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Body

assigneeIdsstring[] | null

attributesstring[]

categoryIdstring | null

companyIdsstring[]

contactEmailstring

contactEntityIdsstring[]

descriptionstring

dueDatestring

equipmentsIdsstring[]

equipmentsQtyobject[]

Show child attributes

fieldsobject[]

Show child attributes

filesobject[]

Show child attributes

locationCommentstring

locationIdsstring[]

maintenanceIdstring

primaryEquipmentIdstring

priorityenum<string>required

Available options: urgent, important, non-critical, uncertain

shouldReturnbooleandefault:true

statusIdstringrequired

Minimum string length: 1

subStatusstring

ticketTypeIdstringrequired

Minimum string length: 1

titlestringrequired

Minimum string length: 1

Response

The created ticket

createdAtstringrequired

descriptionstring | nullrequired

dueDatestring | nullrequired

idnumberrequired

priorityenum<string>required

Available options: urgent, important, non-critical, uncertain

seqIdnumberrequired

statusIdstringrequired

studioIdstringrequired

ticketTypeIdstring | nullrequired

titlestringrequired

updatedAtstringrequired

Still need help? Ask the team