mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
283 lines
8.7 KiB
YAML
283 lines
8.7 KiB
YAML
post:
|
|
tags:
|
|
- Custom Forms
|
|
summary: Import form definitions from export.
|
|
operationId: importFormDefinitions
|
|
requestBody:
|
|
description: Body is the request payload to import form definitions
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
object:
|
|
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
|
|
self:
|
|
type: string
|
|
x-go-name: Self
|
|
version:
|
|
type: integer
|
|
format: int8
|
|
x-go-name: Version
|
|
example: [
|
|
{
|
|
"version": 1,
|
|
"self": {
|
|
"name": "All fields not required",
|
|
"id": "05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa",
|
|
"type": "FORM_DEFINITION"
|
|
},
|
|
"object": {
|
|
"id": "05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa",
|
|
"name": "All fields not required",
|
|
"description": "description",
|
|
"owner": {
|
|
"type": "IDENTITY",
|
|
"id": "3447d8ec2602455ab6f1e8408a0f0150"
|
|
},
|
|
"usedBy": [
|
|
{
|
|
"type": "WORKFLOW",
|
|
"id": "5008594c-dacc-4295-8fee-41df60477304"
|
|
},
|
|
{
|
|
"type": "WORKFLOW",
|
|
"id": "97e75a75-c179-4fbc-a2da-b5fa4aaa8743"
|
|
}
|
|
],
|
|
"formInput": [
|
|
{
|
|
"type": "STRING",
|
|
"label": "input1",
|
|
"description": "A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic"
|
|
}
|
|
],
|
|
"formElements": [
|
|
{
|
|
"id": "3069272797630701",
|
|
"elementType": "SECTION",
|
|
"config": {
|
|
"label": "First Section",
|
|
"formElements": [
|
|
{
|
|
"id": "3069272797630700",
|
|
"elementType": "TEXT",
|
|
"key": "firstName",
|
|
"config": {
|
|
"label": "First Name"
|
|
}
|
|
},
|
|
{
|
|
"id": "3498415402897539",
|
|
"elementType": "TEXT",
|
|
"key": "lastName",
|
|
"config": {
|
|
"label": "Last Name"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"formConditions": [
|
|
{
|
|
"ruleOperator": "AND",
|
|
"rules": [
|
|
{
|
|
"sourceType": "INPUT",
|
|
"source": "Department",
|
|
"operator": "EQ",
|
|
"valueType": "STRING",
|
|
"value": "Sales"
|
|
}
|
|
],
|
|
"effects": [
|
|
{
|
|
"effectType": "HIDE",
|
|
"config": {
|
|
"element": "2614088730489570"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"created": "2022-10-04T19:27:04.456Z",
|
|
"modified": "2022-11-16T20:45:02.172Z"
|
|
}
|
|
}
|
|
]
|
|
required: false
|
|
responses:
|
|
"202":
|
|
description: Returns statuses of those form definition objects imported
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
detail:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
x-go-name: Detail
|
|
key:
|
|
type: string
|
|
x-go-name: Key
|
|
text:
|
|
type: string
|
|
x-go-name: Text
|
|
x-go-name: Errors
|
|
importedObjects:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
object:
|
|
$ref: '../schemas/forms/FormDefinitionResponse.yaml'
|
|
self:
|
|
type: string
|
|
x-go-name: Self
|
|
version:
|
|
type: integer
|
|
format: int8
|
|
x-go-name: Version
|
|
x-go-name: ImportedObjects
|
|
infos:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
detail:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
x-go-name: Detail
|
|
key:
|
|
type: string
|
|
x-go-name: Key
|
|
text:
|
|
type: string
|
|
x-go-name: Text
|
|
x-go-name: Infos
|
|
warnings:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
detail:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
x-go-name: Detail
|
|
key:
|
|
type: string
|
|
x-go-name: Key
|
|
text:
|
|
type: string
|
|
x-go-name: Text
|
|
x-go-name: Warnings
|
|
"400":
|
|
description: An error with the request occurred
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
detailCode:
|
|
type: string
|
|
x-go-name: DetailCode
|
|
messages:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/forms/ErrorMessage.yaml'
|
|
x-go-name: Messages
|
|
statusCode:
|
|
type: integer
|
|
format: int64
|
|
x-go-name: StatusCode
|
|
trackingId:
|
|
type: string
|
|
x-go-name: TrackingID
|
|
"401":
|
|
description: An error with the authorization occurred
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
detailCode:
|
|
type: string
|
|
x-go-name: DetailCode
|
|
messages:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/forms/ErrorMessage.yaml'
|
|
x-go-name: Messages
|
|
statusCode:
|
|
type: integer
|
|
format: int64
|
|
x-go-name: StatusCode
|
|
trackingId:
|
|
type: string
|
|
x-go-name: TrackingID
|
|
"403":
|
|
description: An error with the user permissions occurred
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
detailCode:
|
|
type: string
|
|
x-go-name: DetailCode
|
|
messages:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/forms/ErrorMessage.yaml'
|
|
x-go-name: Messages
|
|
statusCode:
|
|
type: integer
|
|
format: int64
|
|
x-go-name: StatusCode
|
|
trackingId:
|
|
type: string
|
|
x-go-name: TrackingID
|
|
"429":
|
|
description: Too many requests
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/forms/Error.yaml'
|
|
"500":
|
|
description: An internal server error occurred
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
detailCode:
|
|
type: string
|
|
x-go-name: DetailCode
|
|
messages:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/forms/ErrorMessage.yaml'
|
|
x-go-name: Messages
|
|
statusCode:
|
|
type: integer
|
|
format: int64
|
|
x-go-name: StatusCode
|
|
trackingId:
|
|
type: string
|
|
x-go-name: TrackingID
|
|
security:
|
|
- UserContextAuth:
|
|
- sp:forms:manage
|
|
x-codegen-request-body-name: Body |