API by router
Platform forms
List Forms
AuthorizationBearer <token>
In: header
Query Parameters
status?Status
Header Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/forms?status=string" \ -H "X-Api-Key: string"[
{
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",
"form_config": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Form
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
description?Description
entity_definition_id?Entity Definition Id
form_config?Form Config
Empty Object
nameName
Length
length <= 200slugSlug
Length
length <= 100status?Status
Default
"active"Response Body
curl -X POST "https://loading/v1/forms" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "slug": "string" }'{
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",
"form_config": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Form
AuthorizationBearer <token>
In: header
Path Parameters
form_idForm Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"{
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",
"form_config": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Form
AuthorizationBearer <token>
In: header
Path Parameters
form_idForm Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X DELETE "https://loading/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Form
AuthorizationBearer <token>
In: header
Path Parameters
form_idForm Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
description?Description
entity_definition_id?Entity Definition Id
form_config?Form Config
name?Name
status?Status
Response Body
curl -X PUT "https://loading/v1/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"entity_definition_id": "f5e56f39-8997-4d0b-8c9c-2dbcc2c88316",
"form_config": {},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"status": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}