Add new entity to RequiredFields

POST 
/RequiredFields

Add new entity to RequiredFields

Request

application/json

Body

required

New entity

name string
isDefault boolean
requiredQuotationFields string[]
hiddenQuotationFields string[]
disabledQuotationFields string[]
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string

quotationStatuses

object[]

Array [

name string

order int32

Possible values: >= -2147483648 and <= 2147483647

displayInFlow boolean

canExpire boolean

canArchive boolean

id uuid

createdDate date-time

updatedDate date-time

organizationId uuid

reference string

creatorId uuid

customField1 string

customField2 string

customField3 string

customField4 string

customField5 string

organization

]

organization

Responses

201

Created entity

application/json

Schema

Schema

name string
isDefault boolean
requiredQuotationFields string[]
hiddenQuotationFields string[]
disabledQuotationFields string[]
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string

quotationStatuses

object[]

Array [

name string

order int32

Possible values: >= -2147483648 and <= 2147483647

displayInFlow boolean

canExpire boolean

canArchive boolean

id uuid

createdDate date-time

updatedDate date-time

organizationId uuid

reference string

creatorId uuid

customField1 string

customField2 string

customField3 string

customField4 string

customField5 string

organization

]

organization

Example (from schema)

{
  "name": "string",
  "isDefault": true,
  "requiredQuotationFields": [
    "string"
  ],
  "hiddenQuotationFields": [
    "string"
  ],
  "disabledQuotationFields": [
    "string"
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDate": "2024-12-04T06:46:24.808Z",
  "updatedDate": "2024-12-04T06:46:24.808Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customField1": "string",
  "customField2": "string",
  "customField3": "string",
  "customField4": "string",
  "customField5": "string",
  "quotationStatuses": [
    {
      "name": "string",
      "order": 0,
      "displayInFlow": true,
      "canExpire": true,
      "canArchive": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdDate": "2024-12-04T06:46:24.808Z",
      "updatedDate": "2024-12-04T06:46:24.808Z",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "string",
      "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customField1": "string",
      "customField2": "string",
      "customField3": "string",
      "customField4": "string",
      "customField5": "string",
      "organization": {}
    }
  ],
  "organization": {}
}

default

error

application/json

Schema

Schema

error

object

required

code stringrequired

message stringrequired

target string

details

object[]

Array [

code stringrequired

message stringrequired

target string

]

innererror object

The structure of this object is service-specific

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Loading...