Headers
-
X-Correlation-Id string
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language string
Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Path parameters
-
Minimum length is
1
.
Body Required
-
defaultValue string | null
Minimum length is
1
. -
externalId string | null
Minimum length is
1
, maximum length is255
. -
targetProperty string | null
Minimum length is
1
. -
required boolean | null
Default value is
false
. -
Values are
ADDRESS
,BOOLEAN
,DATE
,DATE_TIME
,EMAIL
,FETCH
,LANGUAGE
,LONG_TEXT
,MULTI_SELECT
,NUMBER
,PHONE
,SELECT
,SHORT_TEXT
,TIME_ZONE
, orURL
. -
validator object | null
-
order integer | null
Minimum value is
0
. Default value is0
. -
fetchConfigurationId string | null
Minimum length is
1
. -
answerOptions array[object] | null
Should be used in combination with
inputType: SELECT
orinputType: MULTI_SELECT
POST /forms/{formId}/questions
curl \
-X POST https://api.development.pexipengage.com/enterprises/acme/forms/123/questions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *" \
-d '{"defaultValue":"string","externalId":"ABCD1234","targetProperty":"string","required":true,"hidden":true,"inputType":"SELECT","validator":{"regex":"^.{8}","translations":{"errorMessage":[{"language":"en","value":"Lorem ipsum"}]}},"translations":{"label":[{"language":"en","value":"Lorem ipsum"}],"helpText":[{"language":"en","value":"Lorem ipsum"}],"placeholder":[{"language":"en","value":"Lorem ipsum"}]},"order":5,"fetchConfigurationId":"123","answerOptions":[{"externalId":"ABCD1234","value":"string","translations":{"label":[{"language":"en","value":"Lorem ipsum"}]},"order":5}]}'
Request example
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *
# Payload
{
"defaultValue": "string",
"externalId": "ABCD1234",
"targetProperty": "string",
"required": true,
"hidden": true,
"inputType": "SELECT",
"validator": {
"regex": "^.{8}",
"translations": {
"errorMessage": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
},
"translations": {
"label": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"helpText": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"placeholder": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
},
"order": 5,
"fetchConfigurationId": "123",
"answerOptions": [
{
"externalId": "ABCD1234",
"value": "string",
"translations": {
"label": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
},
"order": 5
}
]
}
Response examples (201)
{
"data": {
"id": "123",
"form": {
"id": "123"
},
"fetchConfiguration": {
"id": "123"
},
"order": 5,
"defaultValue": "string",
"externalId": "ABCD1234",
"targetProperty": "string",
"required": true,
"hidden": true,
"inputType": "SELECT",
"validator": {
"regex": "^.{8}",
"errorMessage": {
"language": "en",
"value": "Lorem ipsum"
},
"translations": {
"errorMessage": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
},
"label": {
"language": "en",
"value": "Lorem ipsum"
},
"helpText": {
"language": "en",
"value": "Lorem ipsum"
},
"placeholder": {
"language": "en",
"value": "Lorem ipsum"
},
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"answerOptions": [
{
"externalId": "ABCD1234",
"value": "string",
"label": {
"language": "en",
"value": "Lorem ipsum"
},
"order": 5,
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"translations": {
"label": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
],
"translations": {
"label": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"helpText": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"placeholder": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (404)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}
Response examples (422)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string",
"arguments": {}
}
]
}