openapi: 3.0.1 info: title: Vasion Automate Pro - External API contact: name: Vasion Support url: https://vasion.com/technical-support/ email: support@vasion.com version: v1 servers: - url: https://qademo.vasion.com/VasionAPI paths: /ext/api/v1/Admin/GetUserList: post: tags: - Admin summary: Get User List description: "Loads a list of all users. The list of users can be narrowed down\ \ to certain types by setting flags.\r\nThis endpoint does not have any required\ \ permissions." operationId: Admin_GetUserList requestBody: content: application/json: schema: $ref: '#/components/schemas/GetUserListReq' text/json: schema: $ref: '#/components/schemas/GetUserListReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/UserListRes' text/json: schema: $ref: '#/components/schemas/UserListRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/LoadEForm: post: tags: - Document summary: Load EForm description: "Load EForm Details. Pass in either the EFormID OR the EFormGUID\ \ value. If both are passed in, only the EFormGUID will be respected.\r\n\ This endpoint does not have any required permissions." operationId: Document_LoadEForm requestBody: content: application/json: schema: $ref: '#/components/schemas/EFormLoadReq' text/json: schema: $ref: '#/components/schemas/EFormLoadReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/EFormRes' text/json: schema: $ref: '#/components/schemas/EFormRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/GetDocument: post: tags: - Document summary: Get Document description: "Load up Document information using a DocumentID. Flags can be\ \ set, in order to return certain information for the document.\r\nThis endpoint\ \ requires the user has access to the document." operationId: Document_GetDocument requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentReq' text/json: schema: $ref: '#/components/schemas/DocumentReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentRes' text/json: schema: $ref: '#/components/schemas/DocumentRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/SaveForm: post: tags: - Document summary: Save Form description: "Saves the document's object fields\r\nThis endpoint requires the\ \ user has access to the document." operationId: Document_SaveForm requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentFormSaveReq' text/json: schema: $ref: '#/components/schemas/DocumentFormSaveReq' required: true responses: "200": description: "An error message if the save fails, otherwise a successful\ \ status code" content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/SubmitEForm: post: tags: - Document summary: Submit EForm description: "Submit an EForm. This will accept the standard form field data,\ \ or a form.io Submission.\r\nThis endpoint requires the user has access to\ \ the draft if there is a draft that already exists being submitted." operationId: Document_SubmitEForm requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitEFormReq' text/json: schema: $ref: '#/components/schemas/SubmitEFormReq' required: true responses: "200": description: "if ReturnDocumentID is set in the Request, this will contain\ \ the Document ID. An error message will be returned if something went\ \ wrong." content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' x-codegen-request-body-name: data /ext/api/v1/Document/GetSubmitEFormTemplate: get: tags: - Document summary: Get SubmitEForm Template description: "Retrieve the submission template for an EForm, either by ID or\ \ by name. This template shows how to submit data for a certain Object.\r\n\ This endpoint does not have any required permissions." operationId: Document_GetSubmitEFormTemplate parameters: - name: eFormID in: query description: The ID for the EForm schema: type: integer format: int32 - name: eFormName in: query description: "The name of the EForm to retrieve, if the ID is not supplied" schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/GetSubmitEFormTemplateRes' text/json: schema: $ref: '#/components/schemas/GetSubmitEFormTemplateRes' /ext/api/v1/Document/DeleteDocuments: post: tags: - Document summary: Delete Documents description: "Attempt to delete one or more Documents. Checks are done on each\ \ Document to make sure the User is able to delete it.\r\nThis endpoint requires\ \ the \"Document - Delete\" role to completely delete the document or the\ \ \"Document - Delete to Recycle Bin\" role to move the document to the recycling\ \ bin" operationId: Document_DeleteDocuments requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentMultiActionReq' text/json: schema: $ref: '#/components/schemas/DocumentMultiActionReq' required: true responses: "200": description: "If one or more Documents are not able to be deleted, an error\ \ string is returned." content: application/json: schema: $ref: '#/components/schemas/GenericStringRes' text/json: schema: $ref: '#/components/schemas/GenericStringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/SaveDocumentLineItemTable2: post: tags: - Document summary: Save Document Line Item Table description: "Save table line item data for a document, generally for an Amazon\ \ Textract process.\r\nThis endpoint requires the \"Document - Edit Line Item\ \ Data\" role" operationId: Document_SaveDocumentLineItemTable2 requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentLineItemTable2Req' text/json: schema: $ref: '#/components/schemas/DocumentLineItemTable2Req' required: true responses: "200": description: "Error message when saving line item data, if any." content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/SaveDocument: post: tags: - Document summary: Save Document description: "Saves a document and its object data, including fields entered\ \ by the user and files uploaded. It combines the UploadDocument and SaveForm\ \ calls.\r\nThis endpoint requires permission to access the folder that the\ \ document is being saved too." operationId: Document_SaveDocument requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveDocumentReq' text/json: schema: $ref: '#/components/schemas/SaveDocumentReq' required: true responses: "200": description: "Error message when saving document data, if any." content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/SaveDataTemplate: get: tags: - Document summary: SaveData Template description: "Retrieve the save template for an document, either by ID or by\ \ name. This template shows how to submit data for a certain Object.\r\nThis\ \ endpoint does not have any required permissions." operationId: Document_SaveDataTemplate parameters: - name: objectId in: query description: The ID of the Object schema: type: integer format: int32 - name: objectName in: query description: "The name of the Object, if the ID is not supplied" schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SaveDataTemplate' text/json: schema: $ref: '#/components/schemas/SaveDataTemplate' security: - API_Token: [] /ext/api/v1/Document/SendDocumentForSignature: post: tags: - Document summary: Send Document For Signature description: "Send a document out to obtain signatures from users.\r\nThis endpoint\ \ requires the \"Admin - Configure Signature App' role." operationId: Document_SendDocumentForSignature requestBody: content: application/json: schema: $ref: '#/components/schemas/SendDocumentForSignatureReq' text/json: schema: $ref: '#/components/schemas/SendDocumentForSignatureReq' required: true responses: "200": description: "Error message when sending signature document, if any." content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Document/GetObjects: get: tags: - Document summary: Get Objects description: "Return a list of Objects that are accessible by the API user.\r\ \nThis endpoint does not have any required permissions." operationId: Document_GetObjects responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AllIndexFormRes' text/json: schema: $ref: '#/components/schemas/AllIndexFormRes' security: - API_Token: [] /ext/api/v1/Document/GetObjectFields: get: tags: - Document summary: Get Objects description: "Get the details for an object with the supplied ID.\r\nThis endpoint\ \ does not have any required permissions." operationId: Document_GetObjectFields parameters: - name: value in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentIndexFormRes' text/json: schema: $ref: '#/components/schemas/DocumentIndexFormRes' security: - API_Token: [] /ext/api/v1/Download/WebDownload: get: tags: - Download summary: Web Download description: "Downloads a Document with various settings. If multiple Document\ \ IDs are entered, it will place them into a Zip file which will be returned.\r\ \nThis endpoint requires the user to have access to the file." operationId: Download_WebDownload parameters: - name: t in: query description: A comma-separated list of Document IDs to download required: true schema: type: string - name: burnAnnotations in: query description: True will attempt to burn any annotations to the document schema: type: string - name: userID in: query description: The ID of the user doing the download; will be verified server side schema: type: string - name: includeWatermark in: query description: True will attempt to apply the configured watermark to the file schema: type: string - name: extractPages in: query description: "Comma-separated list of pages to extract and download (e.g.\ \ \"3,4,7-10\")" schema: type: string - name: convertToPDF in: query description: True will attempt to convert the file to PDF schema: type: string - name: streamPDF in: query description: "True if the PDF should be returned as a stream, rather than\ \ a file. Multiple documents will always be sent as a ZIP file." schema: type: string - name: includeHistory in: query description: True if signing history should be included for the document schema: type: string responses: "200": description: "The returned headers will contain information about the file,\ \ and the content will be the file stream itself.

\r\n \ \ If the streamPDF flag is set, the headers will be:
\r\n\ \ Content-Disposition: inline;filename=\"(Document name)\"\
\r\n Content-Length: (Length of the file in bytes)\r\n Content-Name: (Document name)
\r\n \ \ Content-Type: application/pdf;charset=UTF-8

\r\n \ \ All other files will have the following headers:
\r\n \ \ Content-Disposition: attachment;filename=\"(Document name)\"\r\n Content-Length: (Length of the file in bytes)
\r\ \n Content-Type: application/octet-stream
\r\n \ \ X-Download-Filename: (Document name)
" content: application/json: schema: $ref: '#/components/schemas/StreamContent' text/json: schema: $ref: '#/components/schemas/StreamContent' security: - API_Token: [] /ext/api/v1/Folder/GetFolderList: post: tags: - Folder summary: Get Folder List description: "Retrieves simple list of all folders contained within the folder\ \ with the supplied ID (0 is the root folder).\r\nThis endpoint requires permission\ \ to the folder. If a user does not have permission to view a folder it will\ \ not be included in the list." operationId: Folder_GetFolderList requestBody: content: application/json: schema: $ref: '#/components/schemas/WFFolderListReq' text/json: schema: $ref: '#/components/schemas/WFFolderListReq' required: true responses: "200": description: A list of folders content: application/json: schema: $ref: '#/components/schemas/WFFolderListRes' text/json: schema: $ref: '#/components/schemas/WFFolderListRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Folder/GetFolder: post: tags: - Folder summary: Get Folder description: "Gets the contents of the folder with the supplied ID.\r\nThis\ \ endpoint requires permission to the folder." operationId: Folder_GetFolder requestBody: content: application/json: schema: $ref: '#/components/schemas/FolderReq' text/json: schema: $ref: '#/components/schemas/FolderReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/FolderRes' text/json: schema: $ref: '#/components/schemas/FolderRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Report/DocumentDataExport: post: tags: - Report summary: Document Data Export description: "Export a report of the specified document data. There are a number\ \ of parameters that can be specified to narrow down the data.\r\nThis endpoint\ \ requires the User to have access to the object and/or permission to access\ \ the folder for the report." operationId: Report_DocumentDataExport requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentDataExportReq' text/json: schema: $ref: '#/components/schemas/DocumentDataExportReq' required: true responses: "200": description: "The response will be an array of documents with the Document\ \ information and Object data that has been requested. All fields will\ \ be given as string data. For successful queries, the ResultStatus will\ \ be 1 and the ResultMessage will be null. Failures will be indicated\ \ by a ResultStatus of 0 and an error message in the ResultMessage. The\ \ data JSON element will be null in this case." content: application/json: schema: $ref: '#/components/schemas/JsonDataObject' text/json: schema: $ref: '#/components/schemas/JsonDataObject' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Search/IXSearch: post: tags: - Search summary: Index Search description: "Run an index (object) search of documents.\r\nThis endpoint requires\ \ Global Search to be enabled and the User has access to the search under\ \ secure search (if no one selected, everyone has access)." operationId: Search_IXSearch requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchIndexReq' text/json: schema: $ref: '#/components/schemas/SearchIndexReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SearchIndexRes' text/json: schema: $ref: '#/components/schemas/SearchIndexRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Search/IXSearchWithFTField: post: tags: - Search summary: Index Search With Full Text Field description: "Run an index (object) search of documents, including a full text\ \ field to be searched. The full text field search value must have a FieldID\ \ of 0.\r\nThis endpoint requires Global Search to be enabled and the User\ \ has access to the search under secure search (if no one selected, everyone\ \ has access)." operationId: Search_IXSearchWithFTField requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchIndexReq' text/json: schema: $ref: '#/components/schemas/SearchIndexReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SearchFTDataRes' text/json: schema: $ref: '#/components/schemas/SearchFTDataRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Search/FTSearch: post: tags: - Search summary: Full Text Search description: "Run a full-text search against the documents\r\nThis endpoint\ \ requires Global Search to be enabled and the User has access to the search\ \ under secure search (if no one selected, everyone has access)." operationId: Search_FTSearch requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFullTextReq' text/json: schema: $ref: '#/components/schemas/SearchFullTextReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SearchIndexRes' text/json: schema: $ref: '#/components/schemas/SearchIndexRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Search/FTSearchWithDataCacheDetails: post: tags: - Search summary: Full Text Search With Data Cache Details description: "Run a full-text search against the documents, and caches the full\ \ text details server side.\r\nThis endpoint requires Global Search to be\ \ enabled and the User has access to the search under secure search (if no\ \ one selected, everyone has access)." operationId: Search_FTSearchWithDataCacheDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFullTextReq' text/json: schema: $ref: '#/components/schemas/SearchFullTextReq' required: true responses: "200": description: "Returns the Search Results, as well as a Search GUID which\ \ can be used to access details for a given Document ID and Version ID\ \ later." content: application/json: schema: $ref: '#/components/schemas/FTSearchCacheDetailsRes' text/json: schema: $ref: '#/components/schemas/FTSearchCacheDetailsRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Search/FTSearchWithData: post: tags: - Search summary: Full Text Search With Data description: "Run a full-text search against the documents, with additional\ \ data such as file size, modified or created date, etc.\r\nThis endpoint\ \ requires Global Search to be enabled and the User has access to the search\ \ under secure search (if no one selected, everyone has access)." operationId: Search_FTSearchWithData requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchFullTextReq' text/json: schema: $ref: '#/components/schemas/SearchFullTextReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SearchFTDataRes' text/json: schema: $ref: '#/components/schemas/SearchFTDataRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Upload/UploadDocument: post: tags: - Upload summary: Upload Document description: "Uploads a document, using the encoded data and filename.\r\nThis\ \ endpoint requires the user to have access to the folder the file is being\ \ uploaded too." operationId: Upload_UploadDocument requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadFileReq' text/json: schema: $ref: '#/components/schemas/UploadFileReq' required: true responses: "200": description: "Returns the Document ID if the save was successful, or 0 if\ \ an error occurred" content: application/json: schema: $ref: '#/components/schemas/StringRes' text/json: schema: $ref: '#/components/schemas/StringRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Workflow/GetFullWorkflowList: get: tags: - Workflow summary: Get Full Workflow List description: "Retrieves a simple list of all defined workflows.\r\nThis endpoint\ \ requires the \"Admin - Configure Workflow\" role or the user has been granted\ \ proper permission on the workflow as either an initiator, supervisor or\ \ editor." operationId: Workflow_GetFullWorkflowList responses: "200": description: "A list of id/name pairs representing the ID of the workflow,\ \ as well as its name" content: application/json: schema: $ref: '#/components/schemas/ListSimpleBindRes' text/json: schema: $ref: '#/components/schemas/ListSimpleBindRes' security: - API_Token: [] /ext/api/v1/Workflow/AssignToWF: post: tags: - Workflow summary: Assign to Workflow description: "Attempts to send the given Document ID to a Workflow.\r\nThis\ \ endpoint requires the user to be able to modify the document and have the\ \ \"Admin - Configure Workflow\" role or have permission to initiate the workflow." operationId: Workflow_AssignToWF requestBody: content: application/json: schema: $ref: '#/components/schemas/WFAssignToWFReq' text/json: schema: $ref: '#/components/schemas/WFAssignToWFReq' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/WFAssignToWFRes' text/json: schema: $ref: '#/components/schemas/WFAssignToWFRes' security: - API_Token: [] x-codegen-request-body-name: data /ext/api/v1/Workflow/AssignToWFWithData: post: tags: - Workflow summary: Assign to Workflow With Data description: "Attempts to send the given Document ID to a Workflow\r\nThis endpoint\ \ requires the user to be able to modify the document and have the \"Admin\ \ - Configure Workflow\" role or have permission to initiate the workflow." operationId: Workflow_AssignToWFWithData requestBody: content: application/json: schema: $ref: '#/components/schemas/WFAssignToWFWithDataReq' text/json: schema: $ref: '#/components/schemas/WFAssignToWFWithDataReq' required: true responses: "200": description: "If action is needed before this document can be assigned,\ \ the response will include prompt data. The endpoint can be called again\ \ with the prompt data response. This data will vary depending on the\ \ action needed.
\r\n If Result is True, the document\ \ was submitted with out any problems. However, if the returned type of\ \ prompt is prmt_ChooseFromGroup, the submitter must select a user\ \ from the given GroupID and call the endpoint again:
\r\n \ \ \r\n {\r\n \"documentId\": (document ID)\r\ \n \"workflowId\": (workflow ID)\r\n \"userId\"\ : (user ID)\r\n \"retPromptKey\": \"prmt_ChooseFromGroup\"\ \r\n \"retPromptData\": {\r\n \"cfg_GroupID\"\ : \"(group ID)\"\r\n },\r\n \"promptData\"\ : {\r\n \"prmt_ChooseFromGroup\": {\r\n \ \ \"cfg_UserID\": \"(selected user ID)\"\r\n }\r\ \n }\r\n }" content: application/json: schema: $ref: '#/components/schemas/WFAssignToWFWithDataRes' text/json: schema: $ref: '#/components/schemas/WFAssignToWFWithDataRes' security: - API_Token: [] x-codegen-request-body-name: data components: schemas: GetUserListReq: type: object properties: includeDisabled: type: boolean description: Include users that have been disabled includeExternalSignatureUsers: type: boolean description: Include external users that are primarily for signing documents includeExternalAPIUsers: type: boolean description: Include users defined to use the external API onlyExternalAPIUsers: type: boolean description: Only include external API users UserListRes: type: object properties: Values: type: array description: The list of users items: $ref: '#/components/schemas/UserListItem' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" UserListItem: type: object properties: UserId: type: integer description: The ID of the user format: int32 Username: type: string description: The username (login name) of the user default: "" FirstName: type: string description: First name default: "" MI: type: string description: Middle Initial default: "" LastName: type: string description: Last name default: "" Email: type: string description: The user's email address default: "" FullName: type: string description: The full name of the user default: "" Active: type: boolean description: True if the user is active and able to log in Admin: type: boolean description: True if the user is an administrator LoginDate: type: string description: The date of the user's last login format: date-time Instance: type: string description: The instance (application) they are logging into default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" EFormLoadReq: type: object properties: IncludeUserSecurity: type: boolean description: Return the user and group IDs that can access the EForm EFormID: type: integer description: ID of the EForm format: int32 IncludeFields: type: boolean description: "If true, will return an array of the EForm Fields. Otherwise,\ \ the array will be empty" EFormGUID: type: string description: GUID of the EForm default: "" EFormRes: type: object properties: EFormID: type: integer description: The EForm ID format: int32 Name: type: string description: Name of the EForm default: "" Description: type: string description: Longer description of the EForm default: "" FolderID: type: integer description: ID of the Folder that stores the EForm format: int32 FolderName: type: string description: Name of the folder that stores the EForm default: "" PublicAccessible: type: boolean description: True if the form is publicly accessible IndexFormID: type: integer description: ID of the Object the form is attached to format: int32 WorkflowID: type: integer description: ID of the Workflow that the form will be submitted to format: int32 AllowUploadFiles: type: boolean description: Flag determining if files can be uploaded using this form UploadIndexFieldName: type: string description: The Field Name to which the file will be uploaded default: "" UploadIndexFieldTitle: type: string description: Text used to notify the user that a file can be uploaded default: "" UploadIndexFieldOptions: type: array description: List of option names available for the uploaded files items: type: string AccessUserIDs: type: array description: Integer array of User IDs that can access the Form items: type: integer format: int32 AccessGroupIDs: type: array description: Integer array of Group IDs that can access the Form items: type: integer format: int32 FormFields: type: array description: An array containing the fields for the given form items: $ref: '#/components/schemas/EFormFieldRes' FormIOJSON: type: string description: A string containing the JSON object representing the Form.IO Form default: "" HeaderImageBase64: type: string description: A string containing the base64-encoded header image. May be null or empty default: "" DBLookupIDs: type: array description: List of database lookups (using their ID's) available for the form items: type: integer format: int32 ShowLookupButton: type: boolean description: Flag indicating if the database lookup button is visible RequiresSignature: type: boolean description: Flag indicating if a signature is required prior to submitting this form HasAutoGenerateField: type: boolean description: Flag indicating if an autonumber field is present for this form AutoGenerateNumberField: $ref: '#/components/schemas/AutoGenerateNumberFieldRes' GUID: type: string description: The GUID of the form default: "" ErrorCode: type: integer description: The error code occurring when the form is retrieved format: int32 GenerateFormPdf: type: boolean description: Flag indicating if a PDF of the form will be generated upon submission SignatureLabel: type: string description: Text used to notify the user that a signature is required default: "" PdfPageBreak: type: boolean description: Flag indicating if page breaks will be inserted into the PDF that is generated RequireUploadFiles: type: boolean description: Flag indicating that files are required to be uploaded before submitting the form AttachmentFolderId: type: integer description: ID of the folder where attachments will be sent format: int32 AttachmentFolderName: type: string description: Name of the folder where attachments will be sent default: "" MaxFileSize: type: integer description: Maximum size of the uploaded files format: int32 FileExtensions: type: string description: Extensions of files that can be uploaded (separated by semicolons) default: "" IsAutoSaved: type: boolean description: Flag indicating if the autosave feature is turned on for form drafts IsAnonymous: type: boolean description: "Flag indicating if submissions or anonymous, or tied to a\ \ user" ExpirationTime: type: integer description: Indicates if the form drafts are set to expire format: int32 enum: - 0 - 1 - 2 - 3 - 4 - 5 NumDaysForReminder: type: integer description: Number of days after which the user will be notified of form draft expiry format: int32 WarningEmailTemplateID: type: integer description: Document Template ID of the email sent out warning the user their draft will expire format: int32 DeleteEmailTemplateID: type: integer description: Document Template ID of the email sent out warning the user their draft will be deleted format: int32 InitiationDBLookupIDs: type: array description: List of database lookups (using their ID's) configured to be run before the form is loaded items: type: integer format: int32 ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" EFormFieldRes: type: object properties: EFormFieldID: type: integer description: ID of the field format: int32 EFormID: type: integer description: ID of the EForm the field is attached to format: int32 FieldOrder: type: integer description: Numerical order in which the field is displayed format: int32 MVMappedFieldName: type: string description: The Vasion field name that the field is attached to default: "" FieldType: type: string description: The data type of the field default: "" LabelText: type: string description: The field label used for the field default: "" LabelSize: type: number description: The pixel size of the label when displayed on the form format: double LabelFont: type: string description: The font used for the label default: "" IsRequired: type: boolean description: A flag indicated that this is a required field prior to form submission MiscAttributes: type: object additionalProperties: type: string description: A list of attributes for the field BaseFormFieldID: type: integer description: The Field ID in the base form format: int32 FillGroupNumber: type: integer description: Currently unused format: int32 FieldNameKey: type: string description: The form.io key used for the field default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" AutoGenerateNumberFieldRes: type: object properties: title: type: string description: The title used for the autonumber field default: "" prePendText: type: string description: The text prepended to the autonumber field default: "" autoGenerateNumber: type: string description: The number that is auto generated default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentReq: required: - DocumentId type: object properties: DocumentId: maximum: 2147483647 minimum: 0 type: integer description: The ID of the document to retrieve format: int32 IncludeFileInfo: type: boolean description: Set to include the file information IncludeIndexForm: type: boolean description: Set to include the object information IncludeNotes: type: boolean description: Set to include the document notes IncludeWorkflow: type: boolean description: Set to include information on the workflow the document is in IncludeLinks: type: boolean description: Set to include documents this document is linked to IncludeMaxxLinks: type: boolean description: This field is unused IncludeVersions: type: boolean description: Set to include version history for the document CopyPDF: type: boolean description: This field is unused VersionNumber: type: string description: Which Version Number of the document to retrieve default: "" FileDetail: $ref: '#/components/schemas/FileDetails' WorkflowStepID: type: integer description: The Step ID of the workflow step the document is in format: int32 IncludePackageIndicator: type: boolean description: Flag to include package information Password: type: string description: Password entered for the document default: "" IncludeMeanConfidence: type: boolean description: Include Object confidence information IncludeEFormData: type: boolean description: Include EForm field values FileDetails: type: object properties: Key: type: string description: The key for the uploaded document default: "" Type: type: integer description: "The type of the document (0=Image,1=Native,2=XML,3=Email,4=NativeWeb)" format: int32 enum: - 0 - 1 - 2 - 3 - 4 - -1 PageCount: type: integer description: The number of pages in the document format: int32 Security: $ref: '#/components/schemas/SecurityInfo' SecurityInfo: type: object properties: Value: type: string description: Password for the document default: "" Required: type: boolean description: Flag indicated if the password is required Valid: type: boolean description: Flag indidcating if the security is valid DocumentRes: type: object properties: CreatedById: type: integer description: The User ID of the user that created the document format: int32 CreatedDateUTC: type: string description: The date and time (in UTC) the document was created format: date-time DisplayName: type: string description: The name of the document that gets displayed to the user default: "" DocumentId: type: integer description: The ID of the document format: int32 DocumentName: type: string description: The physical File Name of the document default: "" FileDetail: $ref: '#/components/schemas/FileDetails' EmailFileDetails: $ref: '#/components/schemas/EmailFileDetails' FolderId: type: integer description: The ID of the folder the document is in format: int32 FormId: type: integer description: The Object that the document belongs to format: int32 IncludesFileInfo: type: boolean description: Indicator that the document includes file information IncludesIndexForm: type: boolean description: Indicator that the document includes Object information IncludesNotes: type: boolean description: Indicator that the document includes notes IncludesWorkflow: type: boolean description: Indicator that the document includes workflow information IndexFormFields: $ref: '#/components/schemas/ApiArray_DocumentIndexFieldRes' IndexFormName: type: string description: The name of the Object for the document default: "" IndexForms: $ref: '#/components/schemas/ApiDictionary_Int32_String' ModifiedDateUTC: type: string description: The date and time (in UTC) the document was modified format: date-time ModifiedById: type: integer description: The User ID of the user that modified the document format: int32 OcrId: type: integer description: The ID of the OCR Process that was used format: int32 SecurityContext: $ref: '#/components/schemas/DocumentSecurityContext' Notes: $ref: '#/components/schemas/ApiArray_DocumentNoteRes' Links: $ref: '#/components/schemas/ApiArray_DocumentListItemRes' Versions: $ref: '#/components/schemas/ApiArray_DocumentListItemRes' Tasks: $ref: '#/components/schemas/ApiArray_DocumentTaskRes' MaxxPackages: $ref: '#/components/schemas/ApiArray_MaxxPackage_DocumentPackageRes' Workflow: $ref: '#/components/schemas/WFRes' IsVersion: type: boolean description: True if this document is a version of another document VersionNumber: type: string description: The version number of the document default: "" IsReadOnly: type: boolean description: "True if this file is read-only, and cannot be changed" CanRotate: type: boolean description: True if the pages in the document can be rotated GUID: type: string description: "If the Document was requested by GUID, this field will show\ \ the GUID" default: "" GUIDExpired: type: boolean description: "If the document was requested by GUID, this is true if the\ \ GUID has expired" DownloadToken: type: string description: The download token can be used to initiate a download of the document default: "" ReservedBy: type: integer description: ID of the user that has this document reserved format: int32 LocalPDFName: type: string description: The internal PDF name that is used default: "" CanAddPages: type: boolean description: True if pages can be added to the document readOnlyFolderInfo: $ref: '#/components/schemas/ReadOnlyFolderRes' pendingSignatureDocumentZones: type: array description: The list of signature zones on the document that are still pending items: $ref: '#/components/schemas/SignatureDocumentZoneRes' pendingSignatureAnnotationIDsForCurrentUser: type: array description: ID's of the signature zone annotations that need to be completed items: type: string signatureDocumentAnnotations: type: array description: List of signature zone annotations items: $ref: '#/components/schemas/AnnotationModel' signatureDocumentGUID: type: string description: GUID that is set if this is a signature document default: "" signatureDocumentInitiatorUserID: type: integer description: The ID of the user that initiated the signature document format: int32 HasLinkedSearch: type: boolean description: True if this document has a linked search associated with it applySignatureTimestamp: type: boolean description: True if a timestamp should be added to any signature zones when they are signed meanConfidence: type: number description: The overall confidence of this document if it has been OCR'ed format: float DocPackageViewer: type: array description: List of document packages items: $ref: '#/components/schemas/clsPackageForViewer' CoCIncluded: type: boolean description: True if digitally signed Certificate of Completion is included CertifyDocument: type: boolean description: True if the document should be digitally signed EFormID: type: integer description: the ID of the associated EForm format: int32 SubmittedFormIOData: type: string description: The JSON data submitted from a form.io EForm default: "" IsEFormEditable: type: boolean description: True if the EForm is allowed to be edited IsEFormEditModeDefault: type: boolean description: True if the EForm will be in Edit Mode by Default SignatureData: type: string description: The base64-encoded signature image default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" EmailFileDetails: type: object properties: From: type: string description: Who the email is from default: "" To: type: string description: The recipient of the email default: "" CC: type: string description: Who to carbon copy the email to default: "" BCC: type: string description: Who to blind carbon copy the email to default: "" Subject: type: string description: The email subject default: "" Body: type: string description: The main email body default: "" ApiArray_DocumentIndexFieldRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/DocumentIndexFieldRes' ValueType: type: string default: "" ApiDictionary_Int32_String: type: object properties: Values: type: array items: $ref: '#/components/schemas/KeyValuePair_Int32_String' KeyType: type: string default: "" ValueType: type: string default: "" DocumentSecurityContext: type: object properties: ReadOnly: type: boolean description: Flag indicating that the document is read-only LegalHold: type: boolean description: Flag indicating that the document has a legal hold on it and cannot be changed Reserved: type: boolean description: Flag indicating that a user has reserved the document ReservedById: type: integer description: The ID of the user that has reserved the document format: int32 Roles: $ref: '#/components/schemas/ApiArray_RoleRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ApiArray_DocumentNoteRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/DocumentNoteRes' ValueType: type: string default: "" ApiArray_DocumentListItemRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/DocumentListItemRes' ValueType: type: string default: "" ApiArray_DocumentTaskRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/DocumentTaskRes' ValueType: type: string default: "" ApiArray_MaxxPackage_DocumentPackageRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/MaxxPackage_DocumentPackageRes' ValueType: type: string default: "" WFRes: type: object properties: Completed: type: boolean Name: type: string default: "" InWorkflow: type: boolean PasswordProtected: type: boolean StepName: type: string default: "" StepID: type: integer format: int32 WorkflowId: type: integer format: int32 UserPasswordReq: type: boolean Actions: $ref: '#/components/schemas/ApiArray_WFActionRes' CheckListItems: $ref: '#/components/schemas/ApiArray_WFCheckListItem' Comments: $ref: '#/components/schemas/ApiArray_String' OnlyUserComments: $ref: '#/components/schemas/ApiArray_String' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ReadOnlyFolderRes: type: object properties: IsReadOnly: type: boolean description: True if the folder is read-only CanModify: type: boolean description: True if the document can be modified CanPrint: type: boolean description: True if the document can be printed CanEmail: type: boolean description: True if the document can be emailed CanDelete: type: boolean description: True if the document can be deleted CanExport: type: boolean description: True if the document can be exported CanLaunch: type: boolean description: True if the document can be launched (opened) ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SignatureDocumentZoneRes: type: object properties: signatureDocumentID: type: integer description: ID of the signature document format: int32 annotationID: type: string description: ID of the signature annotation default: "" pageNumber: type: integer description: Page number the signature is located on format: int32 signatureUserID: type: integer description: ID of the user that needs to sign format: int32 signatureUserName: type: string description: Username of the user that needs to sign default: "" signatureUserFullName: type: string description: Full name of the user that needs to sign default: "" completedDate: type: string description: Date and time the signature zone was completed format: date-time roleName: type: string description: Name of the role assigned to the signature user default: "" bottomAlign: type: boolean description: True if the signature is aligned to the bottom of the zone rightAlign: type: boolean description: True if the signature is alighned to the right of the zone isRequired: type: boolean description: True if the signature is required for the document to be completed ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" AnnotationModel: type: object properties: Users: type: array description: List of user ID's for the annotation items: type: integer format: int32 Groups: type: array description: List of group ID's for the annotation items: type: integer format: int32 Name: type: string description: Name of the annotation default: "" AnnType: type: string description: "Annotation type (Rectangle,Text,StickyNote,Image,Picture,Line,PolyLine,Arrow,TextStamp,Empty,Checkbox)\r\ \n///" default: "" Rotate: type: integer description: Degrees of rotation for the annotation format: int32 Print: type: boolean description: True if the annotation should be printed Visible: type: boolean description: True if the annotation is visible Locked: type: boolean description: True if the annotation is unable to be moved Rank: type: integer description: The rank (importance) of the annotation (1=highest priority) format: int32 UniqueID: type: string description: The Unique GUID of the annotation default: "" PosX: type: number description: The X Coordinate of the top-left of the annotation format: double PosY: type: number description: The Y Coordinate of the top-left of the annotation format: double Height: type: number description: The height of the annotation format: double Width: type: number description: The width of the annotation format: double Properties: type: object additionalProperties: type: string description: "A list of annotation properties in (key,value) format" IsRequired: type: boolean description: True if the annotation is required ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" clsPackageForViewer: type: object properties: PackageName: type: string default: "" PackageID: type: integer format: int32 IsSubmitted: type: boolean IsCompleted: type: boolean FieldValuesViewer: type: array items: $ref: '#/components/schemas/clsFieldValuesViewer' DocumentIndexFieldRes: type: object properties: DropDownSelectedValues: $ref: '#/components/schemas/ApiArray_String' TextValue: type: string description: The text value of the field default: "" DateValueUTC: type: string description: The date value of the field in UTC default: "" MeanConfidence: type: number description: The mean confidence of the field if it has been OCR'ed format: float ZoneX: type: number description: The X Position of the upper-left corner of the zone format: float ZoneY: type: number description: The Y Position of the upper-left corner of the zone format: float ZoneWidth: type: number description: The width of the zone format: float ZoneHeight: type: number description: The height of the zone format: float PageNumber: type: integer description: The page number on which the zone is located format: int32 FormId: type: integer description: The ID of the Object this field belongs to format: int32 FieldID: type: integer description: The ID of the field format: int32 FieldName: type: string description: The Vasion internal name of the field default: "" DisplayName: type: string description: The text displayed the user (label) for the field default: "" Control: type: integer description: "The type of control (1=TextBox,2=ComboBox,3=DateTimePicker,4=BlankField,5=ListField,6=Number,7=URL,8=Email,9=Checkboxes,10=RadioButtons,11=Currency,12=Signature,13=TextArea,14=Address)" format: int32 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 FieldLength: type: integer description: The length of the field format: int32 Required: type: boolean description: True if this field is required DropDownValues: $ref: '#/components/schemas/ApiArray_String' FieldOrder: type: integer description: The display order of the field format: int32 Hidden: type: boolean description: True if this field is not visible ReadOnly: type: boolean description: "True if the field is not editable if there is a value (user\ \ can enter an initial value, but then it can't be changed)" Mask: type: integer description: "Type of mask for a text field (0=None,1=SSN,2=Currency)" format: int32 enum: - 0 - 1 - 2 Sticky: type: boolean description: "Indicates if the field is sticky (if a new document is assigned\ \ to the object, it will inherit the last-used value from the previous\ \ document)" SystemDate: type: boolean description: True if the value should be set to the current date if the field is empty or null; otherwise it is not editable PageCount: type: boolean description: True if this field should be populated with the number of pages when the object is assigned; this field is not editable Batch: type: boolean description: Currently unused StickyDropDownValues: $ref: '#/components/schemas/ApiArray_String' StickyTextValue: type: string description: "If the field is sticky, this is the last used text value" default: "" StickyDateValueUTC: type: string description: "If the field is sticky, this is the last used date/time value" default: "" AllowMultiples: type: boolean description: True if multiple values can be selected from a dropdown list ShowCommas: type: boolean description: True if the separator should be shown as part of a numeric field DecimalPlaces: type: integer description: Number of decimal places to display for a numeric field format: int32 CurrencyFormat: type: string description: "For currency fields, this is the format used" default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" KeyValuePair_Int32_String: type: object properties: key: type: integer format: int32 value: type: string default: "" ApiArray_RoleRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/RoleRes' ValueType: type: string default: "" DocumentNoteRes: type: object properties: NoteID: type: integer description: ID of the note format: int32 UserId: type: integer description: ID of the user that created the note format: int32 NameOfUser: type: string description: Name of user that created the note default: "" NoteText: type: string description: Text of the note default: "" CreatedDateUTC: type: string description: Date (in UTC) the note was created format: date-time LinkPageNumber: type: integer description: The page number of the document that the note is linked to format: int32 ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentListItemRes: type: object properties: DocumentId: type: integer description: ID of the document format: int32 DisplayName: type: string description: The name of the document that gets displayed to the user default: "" CreatedUTC: type: string description: The date and time (in UTC) the document was created default: "" ModifiedUTC: type: string description: The date and time (in UTC) the document was modified default: "" VersionedUTC: type: string description: The date and time (in UTC) the document has a new version created for it default: "" IsVersion: type: boolean description: True if this document is a version of a document VersionNumber: type: string description: The version number of this document default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentTaskRes: type: object properties: iDocumentTaskID: type: integer description: The ID of the document task format: int32 iDocumentID: type: integer description: The ID of the document this task is for format: int32 sTaskText: type: string description: The text descritption of the task default: "" iAssignedBy: type: integer description: The ID of the user that assigned this task to the document format: int32 sAssignedByDisplay: type: string description: The name of the user that assigned the task default: "" dtAssignedOn: type: string description: The date and time the task was assigned format: date-time bCompleted: type: boolean description: True if this task has been completed iCompletedBy: type: integer description: ID of the user that completed the task format: int32 sCompletedByDisplay: type: string description: Name of the user that completed the task default: "" dtCompletedOn: type: string description: Date and time the task was completed format: date-time ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" MaxxPackage_DocumentPackageRes: type: object properties: iIndexFormID: type: integer format: int32 iDocumentID: type: integer format: int32 sLinkFieldValue: type: string default: "" iLinkedDocumentID: type: integer format: int32 bHasLink: type: boolean readOnly: true ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ApiArray_WFActionRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/WFActionRes' ValueType: type: string default: "" ApiArray_WFCheckListItem: type: object properties: Values: type: array items: $ref: '#/components/schemas/WFCheckListItem' ValueType: type: string default: "" ApiArray_String: type: object properties: Values: type: array items: type: string ValueType: type: string default: "" clsFieldValuesViewer: type: object properties: FieldName: type: string default: "" FieldValue: type: string default: "" FieldID: type: integer format: int32 IsRequired: type: boolean DocExists: type: boolean DocNames: type: array items: $ref: '#/components/schemas/clsDocName' RoleRes: type: object properties: RoleId: type: integer description: The ID of the role format: int32 Name: type: string description: The name of the role default: "" Description: type: string description: The long description of the role default: "" IsActive: type: boolean description: A flag indicating this role is active SystemName: type: string description: The internal system name of the role default: "" Scope: type: string description: The scope of the role default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" WFActionRes: type: object properties: Label: type: string description: Displayed text for the workflow action default: "" RequireCheckList: type: boolean description: True if a checklist must be completed before performing the action RequireComment: type: boolean description: True if a comment is required for this action RequirePassword: type: boolean description: True if a password is required for this action Status: type: string description: The status that's set when this action is executed default: "" StepId: type: integer description: The ID of the step this action belongs to format: int32 UniqueName: type: string description: The unique name of the action default: "" ActionType: type: string description: The internally used action type default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" WFCheckListItem: type: object properties: ChecklistId: type: integer format: int32 GroupName: type: string default: "" ItemName: type: string default: "" Required: type: boolean clsDocName: type: object properties: Name: type: string default: "" DocumentId: type: integer format: int32 DocumentFormSaveReq: required: - DocumentId - FieldValues - FormId type: object properties: DocumentId: type: integer description: The ID of the document being saved format: int32 StickyValues: $ref: '#/components/schemas/ApiDictionary_String_Boolean' FormIOJSON: type: string description: The form.io JSON containing the field information default: "" IsFromFormView: type: boolean description: True if these values are being saved from the document's Form View mode SignatureData: type: string description: A base64-encoded image containing the signature default: "" EFormID: type: integer description: The ID of the form.io EForm being used to save the data format: int32 FormId: type: integer description: The ID of the Object format: int32 FieldValues: $ref: '#/components/schemas/ApiDictionary_String_String' ApiDictionary_String_Boolean: type: object properties: Values: type: array items: $ref: '#/components/schemas/KeyValuePair_String_Boolean' KeyType: type: string default: "" ValueType: type: string default: "" ApiDictionary_String_String: type: object properties: Values: type: array items: $ref: '#/components/schemas/KeyValuePair_String_String' KeyType: type: string default: "" ValueType: type: string default: "" KeyValuePair_String_Boolean: type: object properties: key: type: string default: "" value: type: boolean KeyValuePair_String_String: type: object properties: key: type: string default: "" value: type: string default: "" StringRes: type: object properties: Value: type: string default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SubmitEFormReq: type: object properties: EFormID: type: integer description: The ID of the EForm format: int32 SubmittedFieldValues: type: object additionalProperties: type: string description: "Should be used with a standard EForm. The property names are\ \ the Field IDs, and the values are the values entered by the User" UploadFile: type: string description: A base64-encoded string of the uploaded file attachment default: "" UploadFileList: type: array description: A string array containing base64 strings of files if more than one was uploaded items: type: string UploadFileName: type: string description: "For a single upload, the physical filename, including extension" default: "" UploadFileNameList: type: array description: A string array containing file names if more than one was uploaded items: type: string UploadFieldValue: type: string description: A user-entered description of the file default: "" UploadFieldValueList: type: array description: A string array containing descriptions of the multiple files that were uploaded items: type: string ReturnDocumentID: type: boolean description: True if the response should include the Document ID that was generated WorkflowDueDate: type: string description: "If not null, contains the workflow due date for the Document" format: date-time FormIOJSON: type: string description: "If submitting through form.io, this is the stringified JSON\ \ from the submission of the form. It contains the field names, and their\ \ entered values." default: "" DefaultSignature: type: string description: A base64-encoded string of a signature image; this will be applied to the various signature fields as needed default: "" WorkFlowID: type: integer description: "The ID of the workflow to submit the form to, if any" format: int32 EFormDraftId: type: integer description: "The ID of the draft being saved under, if any" format: int32 DraftName: type: string description: The name of the draft default: "" DraftAttachments: type: array description: Any attachments to be saved along with the draft items: $ref: '#/components/schemas/EformDraftAttachment' EformDraftAttachment: type: object properties: ID: type: integer description: "The ID for the attachment, if it has been previously saved\ \ (otherwise may be null)" format: int32 OriginalFileName: type: string description: The filename used for the attachment default: "" FileSize: type: string description: "The size of the file, in bytes" default: "" GetSubmitEFormTemplateReq: type: object properties: EFormID: type: integer description: The ID for the EForm format: int32 EFormName: type: string description: "The name of the EForm to retrieve, if the ID is not supplied" default: "" GetSubmitEFormTemplateRes: type: object properties: EFormID: type: integer description: The ID of the EForm format: int32 UploadFieldValue: type: string description: A user-entered description of the file default: "" FormIOJSON: type: string description: "The stringified JSON from the submission of the form. It contains\ \ the field names, and their entered values." default: "" ReturnDocumentID: type: boolean description: True if the response should include the Document ID that was generated workflowDueDate: type: string description: "If not null, contains the workflow due date for the Document" default: "" DefaultSignature: type: string description: A base64-encoded string of a signature image; this will be applied to the various signature fields as needed default: "" WorkflowId: type: integer description: "The ID of the workflow to submit the form to, if any" format: int32 UploadFileList: type: array description: A string array containing base64 strings of files if more than one was uploaded items: type: string UploadFileNameList: type: array description: A string array containing file names if more than one was uploaded items: type: string DraftAttachments: type: array description: Any attachments to be saved along with the draft items: type: string ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentMultiActionReq: required: - DocumentIdString type: object properties: DocumentIdString: type: string description: Comma-separated string of Document IDs to run operations on default: "" ForceRecycle: type: boolean description: True if these should be forced to the recycle folder instead of being physically deleted GenericStringRes: type: object properties: sGenRes: type: string default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentLineItemTable2Req: type: object properties: DocumentId: type: integer description: The ID of the document format: int32 lineItemTables: type: array description: An array of tables that the line items are being saved for items: $ref: '#/components/schemas/LineItemTable2Save' LineItemTable2Save: type: object properties: Tablename: type: string default: "" Footer: type: string default: "" Cells: type: array items: $ref: '#/components/schemas/LineItemTable2CellSave' LineItemTable2CellSave: type: object properties: RowNumber: type: integer format: int32 ColumnNumber: type: integer format: int32 CellType: type: string default: "" RowSpan: type: integer format: int32 ColumnSpan: type: integer format: int32 Value: type: string default: "" MeanConfidence: type: number format: double PageNumber: type: integer format: int32 X: type: number format: float "Y": type: number format: float Height: type: number format: float Width: type: number format: float SaveDocumentReq: type: object properties: FormData: $ref: '#/components/schemas/FormDataSaveReq' uploadFile: $ref: '#/components/schemas/UploadFileReq' FormDataSaveReq: required: - FieldValues - FormId type: object properties: FormId: type: integer description: The ID of the Object format: int32 FieldValues: $ref: '#/components/schemas/ApiDictionary_String_String' UploadFileReq: type: object properties: folderId: type: integer description: "The folder ID that the file will be uploaded to; if not supplied,\ \ the workflowId must be supplied" format: int32 workflowId: type: integer description: "If supplied, the ID of the workflow to submit this document\ \ to; if not supplied, the folderId must be supplied" format: int32 name: type: string description: The filename associated with the file default: "" fileData: type: string description: Base64-encoded representation of the binary file data default: "" uploadedFrom: type: string description: The location it was uploaded from (a freeform application name) default: "" SaveDataTemplateReq: type: object properties: ObjectId: type: integer description: The ID of the Object format: int32 ObjectName: type: string description: "The name of the Object, if the ID is not supplied" default: "" SaveDataTemplate: type: object properties: DocumentId: type: string description: The ID of the document default: "" FormId: type: string description: The ID of the Object default: "" FieldValues: $ref: '#/components/schemas/ApiDictionary_String_String' ErrorMessage: type: string description: "An error message, if any" default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SendDocumentForSignatureReq: type: object properties: TemplateId: type: integer description: The ID for the template to be used format: int32 documentFormSaveReq: $ref: '#/components/schemas/DocumentFormSaveReq' aliasSenderEmail: type: string description: The alias to use for the sender email address default: "" aliasSenderName: type: string description: The alias to use for the sender name default: "" signers: type: array description: A list of users to be created for the template items: $ref: '#/components/schemas/SimpleCreateUserReq' documentDisplayName: type: string description: The display name for the document default: "" messageForSigners: type: string description: The message to be sent to signers to let them know a document needs to be signed default: "" sendToCcRecipients: type: array description: The list of CC recipients items: type: string sendCurrentDocumentID: type: integer description: "The ID of the document to send, if the initiating app wishes\ \ to send an existing document instead of using a template" format: int32 sendCurrentDocumentFile: type: string description: "If the initiating app wishes to send a file instead of using\ \ a templte, this will contain the base64-encoded file data" default: "" SimpleCreateUserReq: type: object properties: emailAddress: type: string description: The user's email address default: "" firstName: type: string description: The first name default: "" lastName: type: string description: The last name default: "" phoneNumber: type: string description: The phone number default: "" roleName: type: string description: "The name of the role for this user, taken from the template" default: "" AllIndexFormRes: type: object properties: IndexForms: type: object additionalProperties: type: string description: "The list of Objects, including their ID and Name" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" StringReq: type: object properties: Value: type: string default: "" DocumentIndexFormRes: type: object properties: FormId: type: integer format: int32 Fields: $ref: '#/components/schemas/ApiArray_DocumentIndexFieldRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" WebDownloadReq: required: - T type: object properties: T: type: string description: A comma-separated list of Document IDs to download default: "" BurnAnnotations: type: string description: True will attempt to burn any annotations to the document default: "" UserID: type: string description: The ID of the user doing the download; will be verified server side default: "" IncludeWatermark: type: string description: True will attempt to apply the configured watermark to the file default: "" ExtractPages: type: string description: "Comma-separated list of pages to extract and download (e.g.\ \ \"3,4,7-10\")" default: "" ConvertToPDF: type: string description: True will attempt to convert the file to PDF default: "" StreamPDF: type: string description: "True if the PDF should be returned as a stream, rather than\ \ a file. Multiple documents will always be sent as a ZIP file." default: "" IncludeHistory: type: string description: True if signing history should be included for the document default: "" StreamContent: type: object properties: Headers: type: array readOnly: true items: $ref: '#/components/schemas/KeyValuePair_String_IEnumerable_String' KeyValuePair_String_IEnumerable_String: type: object properties: key: type: string default: "" value: type: array items: type: string WFFolderListReq: required: - FolderId - Skip - Take type: object properties: FolderId: type: integer description: The ID of the folder to retrieve the list of subfolders from format: int32 Filter: type: string description: The filter to apply to the list of folders default: "" IncludeWFQueue: type: boolean description: A flag indicating if the Workflow Queue should be included in the list Skip: type: integer description: The number of records to skip format: int32 Take: type: integer description: The number of records to retrieve format: int32 EnforceUserSecurity: type: boolean description: A flag indicating if the user's security should be enforced GroupByThirdPartyStorageType: type: boolean description: A flag indicating if the list should be grouped by the storage type (for third party storage folders) StorageConfigId: type: integer description: The ID of the storage configuration format: int32 WFFolderListRes: type: object properties: FolderList: $ref: '#/components/schemas/ApiArray_WFActionFolderItemRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ApiArray_WFActionFolderItemRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/WFActionFolderItemRes' ValueType: type: string default: "" WFActionFolderItemRes: type: object properties: FolderId: type: integer description: The ID of the folder format: int32 ParentId: type: integer description: The ID of the parent folder format: int32 Name: type: string description: The name of the folder default: "" HasChildren: type: boolean description: Whether the folder has children ChildCount: type: integer description: The number of child folders the folder has format: int32 FolderType: type: string description: The type of the folder default: "" HasDocumentsBeneath: type: boolean description: Whether the folder contains documents beneath it CanRename: type: boolean description: Whether the folder can be renamed ThirdPartyStorageConfigId: type: integer description: The ID of the third party storage configuration format: int32 ThirdPartyStorageType: type: string description: The type of the third party storage default: "" IsDocument: type: boolean description: Whether the item is a document FolderReq: required: - FolderId - Skip - Take type: object properties: FolderId: maximum: 2147483647 minimum: 0 type: integer description: The ID of the folder to retrieve format: int32 Skip: maximum: 2147483647 minimum: 0 type: integer description: The number of items to skip format: int32 Take: maximum: 2147483647 minimum: 1 type: integer description: The number of items to retrieve format: int32 OrderBy: type: string description: The name of the field to order by default: "" Ascending: type: boolean description: Whether to order the results in ascending order FolderRes: type: object properties: FolderId: type: integer description: The ID of the folder format: int32 DisplayName: type: string description: The display name of the folder default: "" ParentId: type: integer description: The ID of the parent folder format: int32 Count: type: integer description: The number of items in the folder format: int32 OrderBy: type: string description: The column the results are ordered by default: "" Ascending: type: boolean description: Whether the results are ordered in ascending order Columns: $ref: '#/components/schemas/ApiArray_String' Rows: $ref: '#/components/schemas/ApiArray_FolderViewRowRes' FolderType: type: string default: "" currentPage: type: integer description: The number of the current page of results format: int32 totalPages: type: integer description: The total number of pages of results format: int32 fileCount: type: integer description: The number of files in the folder format: int32 folderCount: type: integer description: The number of folders in the folder format: int32 defaultObject: type: integer description: The ID of the default Object for this folder format: int32 ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ApiArray_FolderViewRowRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/FolderViewRowRes' ValueType: type: string default: "" FolderViewRowRes: type: object properties: Type: type: integer description: "The type of the row (Document, Folder, Shortcut, Unknown)" format: int32 enum: - 0 - 1 - 2 - -1 TypeId: type: integer description: The ID for the type of the row format: int32 Values: $ref: '#/components/schemas/ApiDictionary_String_String' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" DocumentDataExportReq: type: object properties: IndexFormID: type: integer description: The ID of the object to export. format: int32 FolderIDs: type: array description: An Integer array of folders to export. The API user must have access to at least one of the folders. items: type: integer format: int32 OrderedResultFields: type: array description: A string array of fields to order the response records by. items: type: string OrderedOrderByFields: type: array description: A list of fields to order the results by; the first field will be the primary sort field items: type: string SearchFields: type: array description: "An array of fields to search; only matching records will be\ \ returned. The field(s) specified can be from the Document data, or the\ \ Object data. This can be useful to only process records after a certain\ \ date, or following a certain Document ID, or matching only Object data\ \ that matches a certain format." items: $ref: '#/components/schemas/CustomReportSearchFieldReq' CustomReportSearchFieldReq: type: object properties: FieldName: type: string description: The name of the field. default: "" Comparison: type: string description: "One of the following: \"Equals\", \"Starts With\", \"Ends\ \ With\", \"Contains\", \"Is Empty\", \"Not Empty\", \"Greater Than\"\ , \"Less Than\", \"Greater Than Or Equal To\", \"Less Than Or Equal To\"" default: "" FieldValue: type: string description: "The value of the field to compare, specified as a string.\ \ Dates must be of the format mm/dd/yyyy." default: "" AndGroupID: type: integer description: Unused at this time format: int32 JsonDataObject: type: object properties: data: type: object properties: {} description: Generic object that can be serialized to JSON ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SearchIndexReq: required: - Fields - SearchId type: object properties: SearchId: maximum: 2147483647 minimum: 0 type: integer description: The ID of the search to run format: int32 Fields: type: array description: The list of fields to search items: $ref: '#/components/schemas/SearchIndexField' FilterFields: type: array description: The list of fields to filter items: $ref: '#/components/schemas/SearchFilterField' ExactFilter: type: boolean description: "True if the filter must be an exact match, rather than partial" GroupByCustField: type: integer description: The field to group the results by format: int32 SaveSearchName: type: string description: The name to save the search under default: "" OrderBy: type: string description: The field to order the results by default: "" Ascending: type: boolean description: "True if the results are in ascending order, false is descending" SearchIndexField: type: object properties: FormId: type: integer description: The ID of the object the field belongs to format: int32 FormName: type: string description: The name of the object default: "" FieldId: type: integer description: The ID of the field to be searched format: int32 FieldName: type: string description: The field name (column name) to be searched default: "" DisplayName: type: string description: The label for the field default: "" Control: type: integer description: "The type of field (control type used for data entry) 1=TextBox,2=ComboBox,3=DateTimePicker,4=BlankField,5=ListField,6=Number,7=URL,8=Email,9=Checkboxes,10=RadioButtons,11=Currency,12=Signature,13=TextArea,14=Address)" format: int32 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 FieldLength: type: integer description: The length of the field (dropdowns are max char size) format: int32 DropDownValues: type: array description: Drop down options (multi-select) items: type: string Mask: type: integer description: "Type of mask for a text field (0=None,1=SSN,2=Currency)" format: int32 enum: - 0 - 1 - 2 PrimarySearch: type: boolean description: True if this is the main search used for searching the object DropDownSelectedValues: type: array description: "The list of values selected for the dropdown, to be used for\ \ the search" items: type: string TextValue: type: string description: "The text value to search, if the data type is text" default: "" DateValueUTC: type: string description: "The date to search, if the data type is datetime" format: date-time CurrencyFormat: type: string description: "The currency value to search, if the field is a currency field" default: "" SearchFilterField: type: object properties: FieldTitle: type: string description: The label for the field default: "" FieldValue: type: string description: The value for the field default: "" SearchIndexRes: type: object properties: Count: type: integer description: The number of results in the search format: int32 Columns: $ref: '#/components/schemas/ApiArray_String' Rows: $ref: '#/components/schemas/ApiArray_SearchViewRowRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ApiArray_SearchViewRowRes: type: object properties: Values: type: array items: $ref: '#/components/schemas/SearchViewRowRes' ValueType: type: string default: "" SearchViewRowRes: type: object properties: DocumentId: type: integer description: The ID of the document that the row belongs to format: int32 GroupByText: type: string description: The text used for the group by results default: "" Columns: $ref: '#/components/schemas/ApiDictionary_String_String' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SearchFTDataRes: type: object properties: DataItems: type: array description: List of records returned by the search items: $ref: '#/components/schemas/SearchFTItem' Count: type: integer description: The number of results in the search format: int32 Columns: $ref: '#/components/schemas/ApiArray_String' Rows: $ref: '#/components/schemas/ApiArray_SearchViewRowRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SearchFTItem: type: object properties: iDocumentId: type: integer description: The ID of the document format: int32 sText: type: string description: The text found in the document default: "" sNoteText: type: string description: The text found in the document note default: "" sIndexText: type: string description: The text found in the index field default: "" sWFNoteText: type: string description: The text found in the workflow notes default: "" oHitList: type: array description: A list of hits for the text in the document items: type: string ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SearchFullTextReq: required: - FullText - SearchId - SearchType type: object properties: SearchId: maximum: 2147483647 minimum: 0 type: integer description: The ID of the search format: int32 SearchName: type: string description: The name of the search default: "" SearchType: maximum: 2147483647 minimum: 0 type: integer description: "The type of search (161=Full Text,162=Object)" format: int32 FullText: type: string description: The text to be used in the search default: "" SaveSearchName: type: string description: The name to save the search under default: "" More: $ref: '#/components/schemas/SearchFullTextMore' OrderBy: type: string description: The field name to order the results by default: "" Ascending: type: boolean description: "True if the order is ascending, false is descending" SearchFullTextMore: type: object properties: FileName: type: string description: The filename to search default: "" FileExt: type: string description: Type extension of the file default: "" SizeFrom: type: integer description: The minimum size of the file in bytes format: int32 SizeTo: type: integer description: The maximum size of the file in bytes format: int32 CreatedFrom: type: string description: The minimum date the file was created format: date-time CreatedTo: type: string description: The maximum date the file was created format: date-time ModifiedFrom: type: string description: The minimum date the file was modified format: date-time ModifiedTo: type: string description: The maximum date the file was modified format: date-time FTSearchCacheDetailsRes: type: object properties: searchGUID: type: string description: "The GUID of the search, as stored in the cache" default: "" searchResult: $ref: '#/components/schemas/SearchIndexRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" ListSimpleBindRes: type: object properties: Values: type: array description: The list of simple ID/name pairs items: $ref: '#/components/schemas/SimpleBindRes' ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" SimpleBindRes: type: object properties: iID: type: integer description: The ID of the ID/name pair format: int32 sName: type: string description: The value of the ID/name pair default: "" ResultStatus: type: integer description: "The status of the response (0=Unknown,1=Success,2=Error)" format: int32 enum: - 0 - 1 - 2 ResultMessage: type: string description: Any message produced by the endpoint default: "" WFAssignToWFReq: type: object properties: documentId: type: integer description: The ID of the single document to send to the workflow format: int32 documentIDList: type: array description: The list of IDs for documents to be sent to the workflow; this can be sent instead of documentId if multiple documents are required items: type: integer format: int32 workflowId: type: integer description: The ID of the workflow to send the document(s) to format: int32 userId: type: integer description: The ID of the user sending the document to the workflow format: int32 workflowDueDate: type: string description: The due date of the workflow format: date-time WFAssignToWFRes: type: object properties: Result: type: boolean description: "True if the document was successfully assigned to the workflow,\ \ and no further action is necessary" WFAssignToWFWithDataReq: type: object properties: retPromptKey: type: string description: Indicates the type prompt data that is included with the assignment request (e.g. prmt_ChooseFromGroup) default: "" retPromptData: type: object additionalProperties: type: string description: The data for the prompt response promptData: type: object additionalProperties: type: object additionalProperties: type: string description: The prompt data that was sent back from the original call documentId: type: integer description: The ID of the single document to send to the workflow format: int32 documentIDList: type: array description: The list of IDs for documents to be sent to the workflow; this can be sent instead of documentId if multiple documents are required items: type: integer format: int32 workflowId: type: integer description: The ID of the workflow to send the document(s) to format: int32 userId: type: integer description: The ID of the user sending the document to the workflow format: int32 workflowDueDate: type: string description: The due date of the workflow format: date-time WFAssignToWFWithDataRes: type: object properties: retPromptKey: type: string description: Indicates the type prompt data that needs to be included with the assignment request (e.g. prmt_ChooseFromGroup) default: "" retPromptData: type: object additionalProperties: type: string description: The data for the prompt response promptData: type: object additionalProperties: type: object additionalProperties: type: string description: The prompt data that for this type of prompt Result: type: boolean description: "True if the document was successfully assigned to the workflow,\ \ and no further action is necessary" securitySchemes: API_Token: type: http description: "Enter only the API Token. The 'Bearer' scheme will be added automatically." scheme: bearer