{"info":{"contact":{"email":"api@biglelegal.com"},"description":"Documents represent a piece of written, printed, or electronic matter that provides information or evidence or that serves as an official record. They have to be build from an existing template model.","license":{"name":"","url":""},"termsOfService":"https://www.biglelegal.com/en/terms-and-conditions","title":"Bigle API Documents","version":"v1.0.100"},"openapi":"3.0.3","paths":{"/status":{"get":{"description":"This endpoint returns the API status. You either get a successful response if the API is active or an error otherway.","summary":"Get endpoint status.","operationId":"status","tags":["Status"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"environment":{"description":"The Bigle API environment.","type":"string"},"version":{"description":"The Bigle API version.","type":"string"},"requestId":{"description":"The unique request identifier used in the call.","type":"string"}},"example":{"environment":"test","version":"1.0.0","requestId":"7zD45X0U11jWVr45tKy3Gj1LvVA37dyW"}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"LqZf5Xpc00A0t6daadvdM272u2JXI8Rv"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Internal server error"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Internal server error","requestId":"XS1JmLE8Yj8fXHYAr6TIOc2q2RZHFlU8"}}}}}},"security":[{"bearerSecurity":[]}]}},"/":{"post":{"description":"This endpoint creates a new document based on a template.","summary":"Create new internal document.","operationId":"createInternalDocument","tags":["Document"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"documentUid":{"description":"A unique identifier that this document belongs to.","type":"string"}},"example":{"documentUid":"zI165MA7aMniKG7fj8c0iPL5Oi5kffMV"}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"qxYb17zO278kK9N9a37d9Fo9Ht48tPgm"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Document name should be informed","User email should be informed","Template UID should be informed","Document main should be informed","User does not exist","Template does not exist","Template details could not be retreived from database","Model blocks do not exist","Model blocks details could not be retreived from database","Model sections do not exist","Model sections details could not be retreived from database","Model fields do not exist","Model fields details could not be retreived from database","Document could not be created","Document content could not be created","Activity could not be created","Invalid document name","Invalid user email","Invalid template UID","Invalid client ID","Invalid folder UID","Invalid document main","Model subtemplates do not exist","Subtemplates structure do not exist","Model subtemplates details could not be retreived from database","Invalid selected workflow UID","Invalid finished flag"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"I66zF7iJd8O4mYPPeyT1wsb8RgIF6uMu"}}}}}},"security":[{"bearerSecurity":[]}],"requestBody":{"description":"Request body to create a new document","content":{"application/json":{"schema":{"description":"Request body to create a new document","type":"object","properties":{"documentName":{"description":"The documents name, meant to be displayed to the user. Whenever this document is sent, name will show up on the document details.","type":"string"},"userEmail":{"description":"The user email. You must set the email of the user that will own this document.","type":"string"},"templateUid":{"description":"The template identifier of the document. You must set the unique identifier of the template that the document will be build from.","type":"string"},"clientId":{"description":"Optional custom identifier for the document.","type":"string"},"folderUid":{"description":"The folder identifier of the document. You can set the unique identifier of the folder that the document will be placed into.","type":"string"},"main":{"description":"The document main. You must indicate what the values of the document will be. In order to know what JSON you should send, you should call the template main endpoint first.","type":"object","properties":{}},"selectedWorkflowUid":{"description":"The workflow identifier to link to the document.","type":"string"},"finished":{"description":"Flag to indicate that the document should be created and finished at the same time.","type":"boolean"}}}}}}}},"/external":{"post":{"description":"This endpoint creates a new document based on an uploaded a PDF or DOCX file.","summary":"Create new external document.","operationId":"createExternalDocument","tags":["Document"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"documentUid":{"description":"A unique identifier that this document belongs to.","type":"string"},"uploadURL":{"description":"A temporary URL to upload the document.","type":"string"}},"example":{"documentUid":"Yojvdy61s96OOs84PnA1U2adTZjxrSsY","uploadURL":"https://example.com/ref.docx?GoogleAccessId=ID&Expires=1650000000&Signature=r1llPGK9G6GjJQEo5Gz8QpSX2x04vSk5"}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"26o0ncbCAOHrQg3658f3Rh59585P5J9s"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Document name should be informed","User email should be informed","User does not exist","Document could not be created","Activity could not be created","Invalid document name","Invalid user email","Invalid client ID","Invalid folder UID","Invalid PDF file flag","Invalid finished flag"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"zF741T987ski12UQ4phi1X7wQCDi1w10"}}}}}},"security":[{"bearerSecurity":[]}],"requestBody":{"description":"Request body to create a new document","content":{"application/json":{"schema":{"description":"Request body to create a new document","type":"object","properties":{"documentName":{"description":"The documents name, meant to be displayed to the user. Whenever this document is sent, name will show up on the document details.","type":"string"},"userEmail":{"description":"The user email. You must set the email of the user that will own this document.","type":"string"},"pdfFile":{"description":"Flag to be set in case the file is a PDF.","type":"boolean"},"clientId":{"description":"Optional custom identifier for the document.","type":"string"},"folderUid":{"description":"The folder identifier of the document. You can set the unique identifier of the folder that the document will be placed into.","type":"string"},"finished":{"description":"Flag to indicate that the document should be created and finished at the same time.","type":"boolean"}}}}}}}},"/folder":{"get":{"description":"This endpoint retrieves the list of folders.","summary":"Get folders list.","operationId":"getFolders","tags":["Document"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"uid":{"description":"A unique identifier that this folder belongs to.","type":"string"},"name":{"description":"The name of the folder.","type":"string"},"parentFolderUid":{"description":"The unique identifier of the parent folder.","type":"string"},"folders":{"description":"The folders of the folder, including subfolders.","type":"array","items":{"description":"The folders of the folder, including subfolders.","type":"object","properties":{"uid":{"description":"A unique identifier that this folder belongs to.","type":"string"},"name":{"description":"The name of the folder.","type":"string"},"parentFolderUid":{"description":"The unique identifier of the parent folder.","type":"string"},"content":{"description":"The content of the folder, including subfolders.","type":"array","items":{"description":"The content of the folder, including subfolders.","type":"object","properties":{}}}}}},"documents":{"description":"The documents of the folder.","type":"array","items":{"description":"The documents of the folder.","type":"object","properties":{"uid":{"description":"A unique identifier that this document belongs to.","type":"string"},"name":{"description":"The name of the document.","type":"string"}}}}},"example":{"uid":"parentFolderUid","name":"Folder name","parentFolderUid":"74JoivzU3HgaxQk0J048NUjwp8qyXQ3N","folders":[{"uid":"T4FVRsG5gwrM3d1p68bE6mml788X8pKv","name":"Nested Folder name","parentFolderUid":"parentFolderUid","folders":[]}],"documents":[{"uid":"bYq7gl7U25wU810l1NqG0vcv2Bk4gWn4","name":"Document name"}]}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"AnFb84UBa66sk0lz2jz69hv4Gd9C39Km"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Folder name should be informed","Invalid folder uid","Invalid show documents flag","Folders do not exist","Documents do not exist"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"NIFYPhgok5DI5pCiZMgvOZFSGHyNCqI8"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"Root folder to obtain the folder structure","in":"query","name":"folderUid","required":false,"schema":{"description":"Root folder to obtain the folder structure","type":"string"}},{"description":"Whether to show documents in the folder","in":"query","name":"showDocuments","required":false,"schema":{"description":"Whether to show documents in the folder","type":"boolean"}}]},"post":{"description":"This endpoint creates a new folder.","summary":"Create new folder.","operationId":"createFolder","tags":["Document"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"folderUid":{"description":"A unique identifier that this folder belongs to.","type":"string"}},"example":{"folderUid":"pwaH3H56aVZtQL2x6QNJ5xJdo22932s6"}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"g6WFMlraT486IP1wg9bZmMltDwP2l63u"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Folder name should be informed","User email should be informed","User does not exist","User details could not be retreived from database","Folder could not be created","Invalid folder name","Invalid user email","Invalid client ID","Invalid parent folder UID"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"B8MCBt8PmquazY4Bsimd1AahgaAils40"}}}}}},"security":[{"bearerSecurity":[]}],"requestBody":{"description":"Request body to create a new folder","content":{"application/json":{"schema":{"description":"Request body to create a new folder","type":"object","properties":{"folderName":{"description":"The folders name, meant to be displayed to the user. Whenever this folder is sent, name will show up on the folder details.","type":"string"},"userEmail":{"description":"The user email. You must set the email of the user that will own this folder.","type":"string"},"clientId":{"description":"Optional custom identifier for the folder.","type":"string"},"parentFolderUid":{"description":"The parent folder identifier of the folder. You can set the unique identifier of the parent folder that the folder will be placed into.","type":"string"}}}}}}}},"/{documentUid}/metadata/{metadataSetUid}":{"post":{"description":"This endpoint sets the values for a metadata set in a document.","summary":"Set document metadata.","operationId":"setDocumentMetadata","tags":["Document"],"responses":{"204":{"description":"Success","content":{}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"U74cGS7L7al0yq0qkiOKmUZHlOhYr340"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Invalid document uid","Document UID should be informed","Document does not exist","Metadata set UID should be informed","Invalid metadata set uid","Document main should be informed","Invalid document main","Metadata set does not exist","Metadata set not allowed for external documents","Metadata set not allowed for internal documents","Metadata set not allowed for document model"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"3Iq5Pg4YPuPK8zuDkmvk2LiJ5g2SqOSn"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"A unique identifier that this document belongs to.","in":"path","name":"documentUid","required":true,"schema":{"description":"A unique identifier that this document belongs to.","type":"string"}},{"description":"The metadata set unique identifier to be set.","in":"path","name":"metadataSetUid","required":true,"schema":{"description":"The metadata set unique identifier to be set.","type":"string"}}],"requestBody":{"description":"Request body to create a new folder","content":{"application/json":{"schema":{"description":"Request body to create a new folder","type":"object","properties":{"main":{"description":"The metadata main. You must indicate what the values of the metadata will be.","type":"object","properties":{}}}}}}}}},"/{documentUid}":{"delete":{"description":"This endpoint deletes an existing document.","summary":"Delete existing document.","operationId":"deleteDocument","tags":["Document"],"responses":{"204":{"description":"Success","content":{}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"M01oVTlm56Cu15kunat8A6Lv1U6kl31i"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request parameters should be informed","Document does not exist","Document UID should be informed","Document could not be deleted","Document details could not be retreived from database","Invalid document uid"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request parameters should be informed","requestId":"1X0096j4Tv96ZPk57k3DmXyzLx3ONh82"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"A unique identifier that this document belongs to.","in":"path","name":"documentUid","required":true,"schema":{"description":"A unique identifier that this document belongs to.","type":"string"}}]}},"/{documentUid}/render":{"get":{"description":"This endpoint provides a URL to download the rendered document.","summary":"Get download URL.","operationId":"downloadURLDocument","tags":["Document"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"downloadURL":{"description":"A temporary URL to download the rendered document.","type":"string","format":"uri"}},"example":{"downloadURL":"https://example.com/ref.docx?GoogleAccessId=ID&Expires=1650000000&Signature=27OOqhbvU1lf9EmFHiSO36u4a9k638t5"}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"z82ovz67uAUgwBrATht494E3zCS2GxfI"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request parameters should be informed","Document UID should be informed","Invalid document uid","Invalid format","Invalid expiration time","Document does not exist","Document signed URL could not be retrieved"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request parameters should be informed","requestId":"iSuXhC6686IMgCQVsXiuRpiGiU01k25l"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"Chose the format you want to download.","in":"query","name":"format","required":false,"schema":{"description":"Chose the format you want to download.","default":"docx","enum":["docx","pdf"],"type":"string"}},{"description":"Seconds until the signed URL is no longer valid. Maximum value: 7 days. Default value 1 day (max:604800)","in":"query","name":"expirationTime","required":false,"schema":{"description":"Seconds until the signed URL is no longer valid. Maximum value: 7 days. Default value 1 day (max:604800)","default":86400,"maximum":604800,"format":"double","type":"number"}},{"description":"A unique identifier that this document belongs to.","in":"path","name":"documentUid","required":true,"schema":{"description":"A unique identifier that this document belongs to.","type":"string"}}]}},"/{documentUid}/data":{"get":{"description":"This endpoint provides the content of a document.","summary":"Get document data.","operationId":"documentData","tags":["Document"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"documentName":{"description":"Name of the document.","type":"string"},"templateUid":{"description":"Unique identifier of the template used to create the document. Only available for internal documents.","type":"string"},"templateName":{"description":"Name of the template used to create the document. Only available for internal documents.","type":"string"},"externalDocument":{"description":"Flag indicating whether the document is external or internal.","type":"boolean"},"extension":{"description":"The document extension. ","enum":["docx","pdf","xlsx","pptx"],"type":"string"},"groupUid":{"description":"Unique identifier of the group the document belongs to.","type":"string"},"groupName":{"description":"Name of the group the document belongs to.","type":"string"},"userUid":{"description":"Unique identifier of the user who owns the document.","type":"string"},"userName":{"description":"Name of the user who owns the document.","type":"string"},"main":{"description":"The document main.","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"},"imageField":{"description":"Signed URL for image file uploaded to image fields","type":"string"},"annexField":{"description":"Signed URL for annex file uploaded to annex fields","type":"string"},"attachmentField":{"description":"Signed URLs for attachment files uploaded to attachment fields","type":"array","items":{"description":"Signed URLs for attachment files uploaded to attachment fields","type":"string"}},"multipleSection":{"description":"Values for multiple sections","type":"array","items":{"description":"Values for multiple sections","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"}}}}}},"metadata":{"description":"The document metadata sets.","type":"object","properties":{"h258FY0k9WZPl13MbumiIPX89w0bWX96":{"description":"Parameter without description.","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"}}}}},"request":{"description":"The document request information. Only available for documents linked to a request.","type":"object","properties":{"main":{"description":"The request main.","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"},"attachmentField":{"description":"Signed URLs for attachment files uploaded to attachment fields","type":"array","items":{"description":"Signed URLs for attachment files uploaded to attachment fields","type":"string"}},"multipleSection":{"description":"Values for multiple sections","type":"array","items":{"description":"Values for multiple sections","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"}}}}}},"metadata":{"description":"The request metadata sets.","type":"object","properties":{"3RK51LZURgCvIEpbnSQ849K1O2dmk9sO":{"description":"Parameter without description.","type":"object","properties":{"shortTextField":{"description":"Value for short text fields","type":"string"},"longTextField":{"description":"Value for long text fields","type":"string"},"dateField":{"description":"Value (Timestamp) for date fields","format":"double","type":"number"},"numberField":{"description":"Value for number fields","format":"double","type":"number"},"singleChoiceField":{"description":"Option selected for single choice fields","type":"string"},"singleChoiceField_optionA":{"description":"True if \"optionA\" is selected for single choice field","type":"boolean"},"multpleChoiceField":{"description":"Options selected for multiple choice fields","type":"object","properties":{"optionA":{"description":"Value for option \"optionA\". True if selected. False if not selected","type":"boolean"}}},"dropdownField":{"description":"Option selected for dropdown fields","type":"string"},"dropdownField_optionA":{"description":"True if \"optionA\" is selected for dropdown field","type":"boolean"}}}}}}},"fileList":{"description":"Signed URLs for all files uploaded to attachment fields","type":"array","items":{"description":"Signed URLs for all files uploaded to attachment fields","type":"string"}}},"example":{"documentName":"Document Name","templateUid":"K50VOAZ003uU3GdOSCIJSMvYnDvq1aAX","templateName":"Template Name","externalDocument":false,"extension":"docx","groupUid":"CVlG5TBMn8bq1jHPZ304VbHz5NwuJDBW","groupName":"Group Name","userUid":"I8D0JO7A8eAwmtGJSWMKUd2n2yqcSBuZ","userName":"User Name","main":{"shortTextField":"value","longTextField":"value","editorTextField":"value","numberField":1234,"dateField":1788754668547,"singleChoiceField":"option_1","multipleChoiceField":{"option_1":false,"option_2":false},"dropdownField":"option_2","attachmentField":"https://example.com/attachment.pdf","annexField":"https://example.com/annex.pdf","imageField":"https://example.com/image.png"},"metadata":{"fcelq6OOvPV1Z217az3xz5Sz5738hBD4":{"shortTextField":"value","longTextField":"value","editorTextField":"value","numberField":1234,"dateField":1788754668546,"singleChoiceField":"option_1"}},"request":{"main":{"shortTextField":"value","longTextField":"value","editorTextField":"value","numberField":1234,"dateField":1788754668547,"singleChoiceField":"option_1","multipleChoiceField":{"option_1":false,"option_2":false},"dropdownField":"option_2","attachmentField":"https://example.com/attachment.pdf"},"metadata":{"jhd0JvSvT2duu9aLsIH9S0ts7eBA4u4O":{"shortTextField":"value","longTextField":"value","editorTextField":"value","numberField":1234,"dateField":1788754668546,"singleChoiceField":"option_1"}}},"filesList":["https://example.com/attachment.pdf","https://example.com/annex.pdf","https://example.com/image.png"]}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"i4ZBpJQ3uNZRgLWojB71JjoRvFZ4eQ6O"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request parameters should be informed","Document UID should be informed","Document does not exist","Invalid document uid","External documents have no data","Document main could not be retrieved","Metadata sets do not exist","Users do not exist","Groups do not exist"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request parameters should be informed","requestId":"8A8BZGA4rK5K6NQp1hGQJ9H5Km4PpfdQ"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"A unique identifier that this document belongs to.","in":"path","name":"documentUid","required":true,"schema":{"description":"A unique identifier that this document belongs to.","type":"string"}}]}},"/list":{"get":{"description":"This endpoint retrieves a filtered list of documents with pagination support.","summary":"Get documents list with filters.","operationId":"getDocuments","tags":["Document"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"documents":{"description":"The list of documents matching the filter criteria.","type":"array","items":{"description":"The list of documents matching the filter criteria.","type":"object","properties":{"uid":{"description":"A unique identifier that this document belongs to.","type":"string"},"name":{"description":"The name of the document.","type":"string"},"templateUid":{"description":"The template UID used to create the document. Empty for external documents.","type":"string"},"isExternal":{"description":"Flag indicating whether the document is external or internal.","type":"boolean"},"creationTime":{"description":"Timestamp (milliseconds) when the document was created.","format":"double","type":"number"},"lastModificationTime":{"description":"Timestamp (milliseconds) when the document was last modified.","format":"double","type":"number"},"userUid":{"description":"The unique identifier of the user who owns the document.","type":"string"},"parentFolderUid":{"description":"The unique identifier of the folder containing the document.","type":"string"}}}},"hasMore":{"description":"Indicates whether there are more documents available for the next page.","type":"boolean"}},"example":{"documents":[{"uid":"Ut4RC0748T2tHGIf0N7pTxqlxUipN36n","name":"Document name","templateUid":"3t3DthGjQHwNd84GfEe63kg9pA1LR6eD","isExternal":false,"creationTime":1788754668586,"lastModificationTime":1788754668586,"userUid":"MR1I3ad0xcUsmbhSlkgylGBGOV0MM3NX","parentFolderUid":"1yp9KGelXb0MKgh4iouSgAY7cV8ukcyp"}],"hasMore":true}}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"bnp3nntft1nTCLQ8gFdsa2s3q7i2qM3o"}}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Invalid created from date. Expected format: DD/MM/YYYY","Invalid created to date. Expected format: DD/MM/YYYY","Invalid modified from date. Expected format: DD/MM/YYYY","Invalid modified to date. Expected format: DD/MM/YYYY","Invalid date format. Expected format: DD/MM/YYYY","Invalid template UID","Invalid limit value","Invalid last creation time value","Invalid isExternal value","Documents do not exist"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"yH5wq0m7d7YvVBhM4QgI21A1bgUtB136"}}}}}},"security":[{"bearerSecurity":[]}],"parameters":[{"description":"Filter documents created from this date (timestamp in milliseconds)","in":"query","name":"createdFrom","required":false,"schema":{"description":"Filter documents created from this date (timestamp in milliseconds)","format":"double","type":"number"}},{"description":"Filter documents created until this date (timestamp in milliseconds)","in":"query","name":"createdTo","required":false,"schema":{"description":"Filter documents created until this date (timestamp in milliseconds)","format":"double","type":"number"}},{"description":"Filter documents modified from this date (timestamp in milliseconds)","in":"query","name":"modifiedFrom","required":false,"schema":{"description":"Filter documents modified from this date (timestamp in milliseconds)","format":"double","type":"number"}},{"description":"Filter documents modified until this date (timestamp in milliseconds)","in":"query","name":"modifiedTo","required":false,"schema":{"description":"Filter documents modified until this date (timestamp in milliseconds)","format":"double","type":"number"}},{"description":"Filter documents by template UID","in":"query","name":"templateUid","required":false,"schema":{"description":"Filter documents by template UID","type":"string"}},{"description":"Filter documents by external or internal type","in":"query","name":"isExternal","required":false,"schema":{"description":"Filter documents by external or internal type","type":"boolean"}},{"description":"Maximum number of documents to return (max:1000)","in":"query","name":"limit","required":false,"schema":{"description":"Maximum number of documents to return (max:1000)","default":100,"maximum":1000,"format":"double","type":"number"}},{"description":"Cursor for pagination: creationTime of the last document from the previous page (timestamp in milliseconds)","in":"query","name":"lastCreationTime","required":false,"schema":{"description":"Cursor for pagination: creationTime of the last document from the previous page (timestamp in milliseconds)","format":"double","type":"number"}}]}}},"servers":[{"url":"https://europe-west1-bigle-platform.cloudfunctions.net/apiDocumentEU-v1"}],"components":{"securitySchemes":{"bearerSecurity":{"type":"http","scheme":"bearer"}}}}