{ "openapi": "3.0.3", "info": { "title": "@ksaar/public-api", "description": "\nIn order to guarantee everyone a well service, we are using a rate limit. The number of requests from the same account to a single endpoint in 1 minute is limited to 60.\n\nMost of the requests are also paginated. The default page size is 100 and can be increased till 500.\n\n MAX_PAGE_SIZE: 500,\n DEFAULT_PAGE_SIZE: 100,\n DEFAULT_PAGE: 1\n\nThank for using Ksaar API\n", "version": "1.0.179", "contact": {}, "x-jentic-source-url": "https://api.ksaar.co/open-api/" }, "servers": [ { "url": "https://api.ksaar.co" } ], "paths": { "/v1/applications": { "get": { "operationId": "ApplicationsController_findAll_v1", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "Requested page", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Items per page", "schema": { "type": "string" } }, { "name": "sortBy", "required": false, "in": "query", "description": "Sort items by created date or updated date", "schema": { "enum": [ "createdAt", "updatedAt" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedResponseOfApplication", "allOf": [ { "$ref": "#/components/schemas/PaginatedDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "applications" ] } }, "/v1/applications/{id}/workflows": { "get": { "operationId": "ApplicationsController_findAllWorkflowByAppId_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the application", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Requested page", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Items per page", "schema": { "type": "string" } }, { "name": "sortBy", "required": false, "in": "query", "description": "Sort items by created date or updated date", "schema": { "enum": [ "createdAt", "updatedAt" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedResponseOfWorkflow", "allOf": [ { "$ref": "#/components/schemas/PaginatedDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "applications" ] } }, "/v1/applications/{id}/users": { "get": { "operationId": "ApplicationsController_findAllUsersByAppId_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the application", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Requested page", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Items per page", "schema": { "type": "string" } }, { "name": "sortBy", "required": false, "in": "query", "description": "Sort items by created date or updated date", "schema": { "enum": [ "createdAt", "updatedAt" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedResponseOfUser", "allOf": [ { "$ref": "#/components/schemas/PaginatedDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "applications" ] } }, "/v1/applications/{id}/users/email/{email}": { "get": { "operationId": "ApplicationsController_findOneByEmail_v1", "parameters": [ { "name": "email", "required": true, "in": "path", "description": "Email of the user", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the application", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "applications" ] } }, "/v1/applications/{id}/users/fields": { "get": { "operationId": "ApplicationsController_findUserFields_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "User fields of the application", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "applications" ] } }, "/v1/users/{id}": { "get": { "operationId": "UsersController_findOneById_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the user", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "users" ] }, "patch": { "operationId": "UsersController_update_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } } }, "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "users" ] } }, "/v1/users/{id}/files/{fieldId}": { "get": { "operationId": "UsersController_findDocument_v1", "parameters": [ { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "users" ] }, "post": { "operationId": "UsersController_uploadDocument_v1", "parameters": [ { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "users" ] } }, "/v1/users/{id}/files/{fieldId}/{fileId}": { "delete": { "operationId": "UsersController_deleteDocument_v1", "parameters": [ { "name": "fileId", "required": true, "in": "path", "description": "Uuid of the file", "schema": { "type": "string" } }, { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "users" ] } }, "/v1/workflows/{id}/records": { "post": { "operationId": "WorkflowsController_create_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the workflow", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordCreate" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "default": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Record" } } } } }, "security": [ { "basic": [] } ], "tags": [ "workflows" ] }, "get": { "operationId": "WorkflowsController_findAll_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the workflow", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "Requested page", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Items per page", "schema": { "type": "string" } }, { "name": "sortBy", "required": false, "in": "query", "description": "Sort items by created date or updated date", "schema": { "enum": [ "createdAt", "updatedAt" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "PaginatedResponseOfRecord", "allOf": [ { "$ref": "#/components/schemas/PaginatedDto" }, { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Record" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "workflows" ] } }, "/v1/workflows/{id}/records/count": { "get": { "operationId": "WorkflowsController_count_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the workflow", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "workflows" ] } }, "/v1/workflows/{id}/fields": { "get": { "operationId": "WorkflowsController_findAllFieldsByAppIdAndWorkflowId_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the workflow", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "workflows" ] } }, "/v1/records/{id}": { "get": { "operationId": "RecordController_findRecord_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "default": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Record" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] }, "patch": { "operationId": "RecordController_update_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordUpdate" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "default": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Record" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] }, "delete": { "operationId": "RecordController_delete_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } }, "/v1/records/bulkCreate": { "post": { "operationId": "RecordController_bulkCreate_v1", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRecordCreate" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } }, "/v1/records/bulkUpdate": { "post": { "operationId": "RecordController_bulkUpdate_v1", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRecordUpdateDto" } } } }, "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } }, "/v1/records/bulkDelete": { "post": { "operationId": "RecordController_bulkDelete_v1", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRecordDeleteDto" } } } }, "responses": { "200": { "description": "Successful response" }, "204": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } }, "/v1/records/{id}/files/{fieldId}": { "get": { "operationId": "RecordController_findDocument_v1", "parameters": [ { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] }, "post": { "operationId": "RecordController_uploadDocument_v1", "parameters": [ { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } }, "/v1/records/{id}/files/{fieldId}/{fileId}": { "delete": { "operationId": "RecordController_deleteDocument_v1", "parameters": [ { "name": "fileId", "required": true, "in": "path", "description": "Uuid of the file", "schema": { "type": "string" } }, { "name": "fieldId", "required": true, "in": "path", "description": "Uuid of the field", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "description": "Uuid of the record", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basic": [] } ], "tags": [ "records" ] } } }, "components": { "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } }, "schemas": { "PaginatedDto": { "type": "object", "properties": { "total": { "type": "number", "example": 100, "description": "Total page" }, "lastPage": { "type": "number", "example": 10, "description": "Last Page" }, "currentPage": { "type": "number", "example": 2, "description": "Id of the application" } }, "required": [ "total", "lastPage", "currentPage" ] }, "Application": { "type": "object", "properties": { "id": { "type": "string", "example": "8f98e48e-8fe4-4a49-bd61-e47cf3f2e74f", "description": "UUID" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Updated Date" }, "createdAt": { "format": "date-time", "type": "string", "description": "Created Date" }, "name": { "type": "string", "example": "MyCRM", "description": "Name of the application" } }, "required": [ "id", "updatedAt", "createdAt", "name" ] }, "Workflow": { "type": "object", "properties": { "id": { "type": "string", "example": "8f98e48e-8fe4-4a49-bd61-e47cf3f2e74f", "description": "UUID" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Updated Date" }, "createdAt": { "format": "date-time", "type": "string", "description": "Created Date" }, "name": { "type": "string", "example": "Ajouter une facture", "description": "Name of the workflow" }, "applicationId": { "type": "string", "example": "cfe18129-0e5d-4859-8310-f38df59ba92c", "description": "ID of the application" } }, "required": [ "id", "updatedAt", "createdAt", "name", "applicationId" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "example": "8f98e48e-8fe4-4a49-bd61-e47cf3f2e74f", "description": "UUID" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Updated Date" }, "createdAt": { "format": "date-time", "type": "string", "description": "Created Date" }, "applicationId": { "type": "string", "example": "2c87e947-7d34-4213-ac30-2751cf8b00a2", "description": "Application id" }, "personaId": { "type": "string", "example": "5f76d405-02fb-40f9-86b1-559dfeb074f5", "description": "Persona id" }, "email": { "type": "string", "example": "firstname.lastname@domain.com", "description": "User email, also used as login" }, "firstName": { "type": "string", "example": "Jean", "description": "User firstname" }, "lastName": { "type": "string", "example": "Rosier", "description": "User lastName" }, "phone": { "type": "string", "example": "+33123456789", "description": "User phone number" }, "fields": { "type": "object", "example": { "Email address": "firstname.lastname@yopmail.com" }, "description": "User field values" }, "status": { "type": "string", "example": "registered", "description": "User status", "enum": [ "checkedIn", "invited", "registered", "disabled", "deleted" ] } }, "required": [ "id", "updatedAt", "createdAt", "applicationId", "personaId", "email", "firstName", "lastName", "phone", "fields", "status" ] }, "UserUpdate": { "type": "object", "properties": { "fields": { "type": "object", "example": { "firstName": "John", "4ba0bc35-3ace-4f1d-a877-b5a94619029d": "value" }, "description": "Form fields values" } }, "required": [ "fields" ] }, "RecordCreate": { "type": "object", "properties": { "email": { "type": "string", "example": "firstname.lastname@yopmail.com", "description": "email" }, "form": { "type": "object", "example": { "4ba0bc35-3ace-4f1d-a877-b5a94619029d": "Text value", "9abc2e31-7367-4f14-a539-53890eaddd27": 23, "7a9fa3e6-c509-4ff3-92dc-a119514db852": { "url": "https://link_to_my_file.com", "filename": "document.pdf" }, "6fc588ba-8d5a-419b-af70-edab961f7b77": "2023-01-01T11:00:00.000Z", "8abbba77-ebc2-407e-b0a6-d60b67ce9a01": { "begin": "2023-01-01T11:00:00.000Z", "end": "2023-01-02T10:00:00.000Z" }, "6ae88435-ac38-4fbc-b8d0-74bf728b27ee": [ "Checkbox Option 1 | 5e67b219-c45f-4009-a2d4-fe1cec56620a", "Checkbox Option 2 | 7649d083-4a1a-45d0-8cbf-f8f0e4fbe5c4" ], "2283fd92-30bc-445d-be1e-0113a54ad0a9": "Radio option 1 | 31b8d67e-8431-4821-9573-864070ed124f", "b4b544d3-cd18-449d-9080-30595ec78c94": "bc5a2717-ee95-4d3e-b984-2f6666800f14" }, "description": "Form fields values. Keys are field id" } }, "required": [ "email", "form" ] }, "Record": { "type": "object", "properties": { "id": { "type": "string", "example": "4ba0bc35-3ace-4f1d-a877-b5a94619029d", "description": "id" }, "createdAt": { "type": "string", "example": "2023-01-07T21:50:33.211Z", "description": "createdAt" }, "updatedAt": { "type": "string", "example": "2023-01-10T15:25:36.752Z", "description": "updatedAt" }, "userId": { "type": "string", "example": "24e8c423-676e-4c5c-afa6-6fd1ee6b021b", "description": "userId" }, "workflowId": { "type": "string", "example": "bca96ed6-d136-480a-865d-e369094fd429", "description": "workflowId" }, "Linked answer": { "type": "string", "example": "e282a9b5-ed59-4fd3-b20a-18475a7566ac", "description": "Linked answer" }, "Linked user": { "type": "string", "example": "16f91a73-bfa6-46f7-be5c-fd1c0398a282", "description": "Linked user" }, "Date": { "type": "string", "example": "2022-10-09T22:00:00.000Z", "description": "Date" }, "Paragraph": { "type": "string", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.", "description": "Paragraph" }, "Text": { "type": "string", "example": "Paris", "description": "Text" }, "Datetime": { "type": "string", "example": "2023-01-10T18:27:00.000Z", "description": "Datetime" }, "user": { "type": "object", "example": { "id": "24e8c423-676e-4c5c-afa6-6fd1ee6b021b", "createdAt": "2022-11-18T15:11:12.662Z", "updatedAt": "2022-11-18T15:11:12.662Z", "applicationId": "9d17974b-b0ed-49ac-bddc-9e62f493e478", "personaId": "63c25537-91af-4424-afb3-62b05eb6586b", "status": "deleted", "email": "luc.maker@applicatif.net", "firstName": "Luc", "lastName": "(Maker)", "phone": null, "temporary": false, "fields": { "Email": "luc.maker@applicatif.net", "Numéro de mobile": null, "Nom": "(Maker)", "Prénom": "Luc", "QCU": null, "Fichier": { "id": "6e305ff9-ed1a-4987-b267-f6aa188a7d70", "filename": "au+dd.pdf", "url": "https://ksaar-application-production-bucket.s3.eu-west-1.amazonaws.com/undefined/1673364196956_au%2Bdd.pdf?AWSAccessKeyId=AKIA2X276STEVQE56KNL&Expires=1673364506&Signature=VMvLLqhut%2FkKScCFNm3TO7VUzFo%3D" } } }, "description": "user" }, "Multi Select": { "type": "object", "example": [ { "optionId": "d70d0662-30f3-44b2-b833-a343202925ed", "value": "Option 1" } ], "description": "Multi Select" }, "Date range": { "type": "object", "example": "2022-10-09T22:00:00.000Z", "description": "Date range" }, "Multiple Linked answer": { "type": "object", "example": [ "e282a9b5-ed59-4fd3-b20a-18475a7566ac" ], "description": "Multiple Linked answer" }, "Single Select": { "type": "object", "example": { "optionId": "2d3070c8-8eb6-4209-8721-43797b858062", "value": "Option 1" }, "description": "Single Select" }, "Number": { "type": "number", "example": { "id": "6e305ff9-ed1a-4987-b267-f6aa188a7d70", "filename": "au+dd.pdf", "url": "https://ksaar-application-production-bucket.s3.eu-west-1.amazonaws.com/undefined/1673364196956_au%2Bdd.pdf?AWSAccessKeyId=AKIA2X276STEVQE56KNL&Expires=1673364506&Signature=VMvLLqhut%2FkKScCFNm3TO7VUzFo%3D" }, "description": "Number" }, "File": { "type": "object", "example": { "id": "6e305ff9-ed1a-4987-b267-f6aa188a7d70", "filename": "au+dd.pdf", "url": "https://ksaar-application-production-bucket.s3.eu-west-1.amazonaws.com/undefined/1673364196956_au%2Bdd.pdf?AWSAccessKeyId=AKIA2X276STEVQE56KNL&Expires=1673364506&Signature=VMvLLqhut%2FkKScCFNm3TO7VUzFo%3D" }, "description": "File" } }, "required": [ "id", "createdAt", "updatedAt", "userId", "workflowId", "Linked answer", "Linked user", "Date", "Paragraph", "Text", "Datetime", "user", "Multi Select", "Date range", "Multiple Linked answer", "Single Select", "Number", "File" ] }, "RecordUpdate": { "type": "object", "properties": { "form": { "type": "object", "example": { "4ba0bc35-3ace-4f1d-a877-b5a94619029d": "Text value", "9abc2e31-7367-4f14-a539-53890eaddd27": 23, "7a9fa3e6-c509-4ff3-92dc-a119514db852": { "url": "https://link_to_my_file.com", "filename": "document.pdf" }, "6fc588ba-8d5a-419b-af70-edab961f7b77": "2023-01-01T11:00:00.000Z", "8abbba77-ebc2-407e-b0a6-d60b67ce9a01": { "begin": "2023-01-01T11:00:00.000Z", "end": "2023-01-02T10:00:00.000Z" }, "6ae88435-ac38-4fbc-b8d0-74bf728b27ee": [ "Checkbox Option 1 | 5e67b219-c45f-4009-a2d4-fe1cec56620a", "Checkbox Option 2 | 7649d083-4a1a-45d0-8cbf-f8f0e4fbe5c4" ], "2283fd92-30bc-445d-be1e-0113a54ad0a9": "Radio option 1 | 31b8d67e-8431-4821-9573-864070ed124f", "b4b544d3-cd18-449d-9080-30595ec78c94": "bc5a2717-ee95-4d3e-b984-2f6666800f14" }, "description": "Form fields values. Keys are field id" } }, "required": [ "form" ] }, "BulkRecordCreate": { "type": "object", "properties": { "workflowId": { "type": "string", "example": "4ba0bc35-3ace-4f1d-a877-b5a94619029d", "description": "workflowId" }, "records": { "description": "Array of RecordCreate", "type": "array", "items": { "$ref": "#/components/schemas/RecordCreate" } } }, "required": [ "workflowId", "records" ] }, "BulkRecordUpdateDto": { "type": "object", "properties": { "applicationId": { "type": "string", "example": "4ba0bc35-3ace-4f1d-a877-b5a94619029d", "description": "applicationId" }, "records": { "description": "Record of AnswersChanges", "type": "array", "items": { "$ref": "#/components/schemas/RecordUpdate" } } }, "required": [ "applicationId", "records" ] }, "BulkRecordDeleteDto": { "type": "object", "properties": { "recordIds": { "description": "Array of answerId", "type": "array", "items": { "type": "array" } }, "applicationId": { "type": "string", "example": "4ba0bc35-3ace-4f1d-a877-b5a94619029d", "description": "applicationId" } }, "required": [ "recordIds", "applicationId" ] }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "tags": [] }