Get entities from RequiredFields
GET/RequiredFields
Get entities from RequiredFields
Request
Query Parameters
Show only the first n items
Skip the first n items
Search items by search phrases
Filter items by property values
Include count of items
Possible values: [name
, name desc
, isDefault
, isDefault desc
, requiredQuotationFields
, requiredQuotationFields desc
, hiddenQuotationFields
, hiddenQuotationFields desc
, disabledQuotationFields
, disabledQuotationFields desc
, id
, id desc
, createdDate
, createdDate desc
, updatedDate
, updatedDate desc
, organizationId
, organizationId desc
, reference
, reference desc
, creatorId
, creatorId desc
, customField1
, customField1 desc
, customField2
, customField2 desc
, customField3
, customField3 desc
, customField4
, customField4 desc
, customField5
, customField5 desc
]
Order items by property values
Possible values: [name
, isDefault
, requiredQuotationFields
, hiddenQuotationFields
, disabledQuotationFields
, id
, createdDate
, updatedDate
, organizationId
, reference
, creatorId
, customField1
, customField2
, customField3
, customField4
, customField5
, quotationStatuses
, organization
]
Select properties to be returned
Possible values: [*
, quotationStatuses
, organization
]
Expand related entities
Responses
- 200
- default
Retrieved entities
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
value
object[]
quotationStatuses
object[]
Possible values: >= -2147483648
and <= 2147483647
{
"value": [
{
"name": "string",
"isDefault": true,
"requiredQuotationFields": [
"string"
],
"hiddenQuotationFields": [
"string"
],
"disabledQuotationFields": [
"string"
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2024-06-06T15:30:37.672Z",
"updatedDate": "2024-06-06T15:30:37.672Z",
"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-06-06T15:30:37.672Z",
"updatedDate": "2024-06-06T15:30:37.672Z",
"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": {}
}
]
}
error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
required
details
object[]
The structure of this object is service-specific
{
"error": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string"
}
],
"innererror": {}
}
}