{ "swagger": "2.0", "info": { "title": "DocumentsCorePack", "description": "DocumentsCorePack is a fast & simple document generation based on Dynamics 365 data. Based on MS Word - templates, DocumentsCorePack provides you with a set of tools to create and process documents effectively. From a document generation wizard that guides users through the process to full document automation - DocumentsCorePack will make your business documents look professional and help you to process them efficiently!", "termsOfService": "https://www.mscrm-addons.com/Support/Terms-Conditions", "contact": { "name": "mscrm-addons.com", "url": "https://support.mscrm-addons.com", "email": "support@mscrm-addons.com" }, "license": { "name": "All rights reserved, copyright by PTM EDV Systeme GmbH @2023", "url": "https://www.mscrm-addons.com" }, "version": "5.3", "x-ms-keywords": [ "DocumentsCorePack", "Document Core Pack", "Documents Core Pack", "Documents CorePack", "Document CorePack", "DCP", "Document", "Documents", "Doc", "Docs", "Template", "Templates", "Word Template", "Word Templates", "Generate Document", "Generate Documents", "Create Document", "Create Documents", "Document Generation", "Document Automation", "Document Processing", "Send Documents", "Send Document", "Automate Document", "Automate Documents", "PDF", "Word", "DOCX", "Report", "Reports", "Contract", "Contracts", "Invoice", "Invoices", "Quote", "Quotes", "Agreement", "Agreements", "Letter", "Letters", "Merge", "Mail Merge", "Print", "Email", "Email Attachment", "Attachment", "Attachments", "SharePoint", "Sign document", "Signature", "Signatures", "Esignature", "E-signature", "Electronic Signature", "E-sign", "Approval", "Approvals" ] }, "host": "documentapi.mscrm-addons.com", "schemes": [ "https" ], "paths": { "/api/DCP/AttachDocumentJobToEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob to email", "description": "Attach the file generated by a DocumentJob as attachment to a Dynamics 365 email", "operationId": "AttachDocumentJobToEmail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "DocumentJob and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToEmail" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToEmail", "revision": 1 } } }, "/v2/api/DCP/AttachDocumentJobToEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob to email (V2)", "description": "Attach the Document Content generated by a DocumentJob as attachment to a Dynamics 365 email", "operationId": "AttachDocumentJobToEmailV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "DocumentJob and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToEmailV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToEmail", "revision": 2 } } }, "/v3/api/DCP/AttachDocumentJobToEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob to email (V3)", "description": "Attach the document content generated by a DocumentJob as attachment to a Dynamics 365 email.", "operationId": "AttachDocumentJobToEmailV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "DocumentJob and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToEmailV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToEmail", "revision": 3 } } }, "/v4/api/DCP/AttachDocumentJobToEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob to email (V4)", "description": "Attach the document content generated by a DocumentJob as attachment to a Dynamics 365 email.", "operationId": "AttachDocumentJobToEmailV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "DocumentJob and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToEmailV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToEmail", "revision": 4 } } }, "/v5/api/DCP/AttachDocumentJobToEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob to email", "description": "Attach the document content generated by a DocumentJob as attachment to a Dynamics 365 email.", "operationId": "AttachDocumentJobToEmailV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "DocumentJob and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToEmailV5" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToEmail", "revision": 5 } } }, "/api/DCP/AttachDocumentJobToNote": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob as note", "description": "Attach the file generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished", "operationId": "AttachDocumentJobToNote", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToNote" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToNote", "revision": 1 } } }, "/v2/api/DCP/AttachDocumentJobToNote": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob as note (V2)", "description": "Attach the Document Content generated by a DocumentJob as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished", "operationId": "AttachDocumentJobToNoteV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToNoteV2" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToNote", "revision": 2 } } }, "/v3/api/DCP/AttachDocumentJobToNote": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob as note (V3)", "description": "Attach document generated by a DocumentJob as a note to a Dynamics 365 record.", "operationId": "AttachDocumentJobToNoteV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToNoteV3" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToNote", "revision": 3 } } }, "/v4/api/DCP/AttachDocumentJobToNote": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob as note (V4)", "description": "Attach document generated by a DocumentJob as a note to a Dynamics 365 record.", "operationId": "AttachDocumentJobToNoteV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToNoteV4" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToNote", "revision": 4 } } }, "/v5/api/DCP/AttachDocumentJobToNote": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Attach DocumentJob as note", "description": "Attach document generated by a DocumentJob as a note to a Dynamics 365 record.", "operationId": "AttachDocumentJobToNoteV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachDocumentJobToNoteV5" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "AttachDocumentJobToNote", "revision": 5 } } }, "/api/DCP/AttachFileToEmail": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file to email", "description": "Attach the base64 encoded file as attachment to a Dynamics 365 email", "operationId": "AttachFileToEmail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToEmail" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToEmail", "revision": 1 } } }, "/v2/api/DCP/AttachFileToEmail": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file to email (V2)", "description": "Attach the Document Content or base64 encoded file as attachment to a Dynamics 365 email", "operationId": "AttachFileToEmailV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToEmailV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToEmail", "revision": 2 } } }, "/v3/api/DCP/AttachFileToEmail": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file to email (V3)", "description": "Attach a document content or base64 encoded file as attachment to a Dynamics 365 email.", "operationId": "AttachFileToEmailV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToEmailV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToEmail", "revision": 3 } } }, "/v4/api/DCP/AttachFileToEmail": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file to email (V4)", "description": "Attach a document content or base64 encoded file as attachment to a Dynamics 365 email.", "operationId": "AttachFileToEmailV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToEmailV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToEmail", "revision": 4 } } }, "/v5/api/DCP/AttachFileToEmail": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file to email", "description": "Attach a document content or base64 encoded file as attachment to a Dynamics 365 email.", "operationId": "AttachFileToEmailV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Email Information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToEmailV5" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToEmail", "revision": 5 } } }, "/api/DCP/AttachFileToNote": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file as note", "description": "Attach the file supplied as base64 string as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished", "operationId": "AttachFileToNote", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToNote" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToNote", "revision": 1 } } }, "/v2/api/DCP/AttachFileToNote": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file as note (V2)", "description": "Attach the Document Content or base64 encoded file as a note to a Dynamics 365 entity. Attention! The documentjob must already be finished", "operationId": "AttachFileToNoteV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToNoteV2" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToNote", "revision": 2 } } }, "/v3/api/DCP/AttachFileToNote": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file as note (V3)", "description": "Attach a document content or base64 encoded file as a note to a Dynamics 365 record.", "operationId": "AttachFileToNoteV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToNoteV3" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToNote", "revision": 3 } } }, "/v4/api/DCP/AttachFileToNote": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file as note (V4)", "description": "Attach a document content or base64 encoded file as a note to a Dynamics 365 record.", "operationId": "AttachFileToNoteV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToNoteV4" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToNote", "revision": 4 } } }, "/v5/api/DCP/AttachFileToNote": { "post": { "tags": [ "FileFunctions" ], "summary": "Attach file as note", "description": "Attach a document content or base64 encoded file as a note to a Dynamics 365 record.", "operationId": "AttachFileToNoteV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Note information", "required": true, "schema": { "$ref": "#/definitions/JSONAttachFileToNoteV5" } } ], "responses": { "200": { "description": "Returns an AnnotationId", "schema": { "$ref": "#/definitions/JSONCreateNoteResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "AttachFileToNote", "revision": 5 } } }, "/api/DCP/ConcatenateDocumentJobs": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two DocumentJobs", "description": "Concatenate two files (pdf,docx) generated by two DocumentJobs", "operationId": "ConcatenateDocumentJobs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two DocumentJobs to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatDocumentJob" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateDocumentJobs", "revision": 1 } } }, "/v2/api/DCP/ConcatenateDocumentJobs": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two DocumentJobs (V2)", "description": "Concatenate two Document Contents (pdf,docx) generated by two DocumentJobs", "operationId": "ConcatenateDocumentJobsV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two DocumentJobs to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatDocumentJobV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateDocumentJobs", "revision": 2 } } }, "/v3/api/DCP/ConcatenateDocumentJobs": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two DocumentJobs (V3)", "description": "Concatenate two DocumentJobs. Supported filetypes: pdf, docx.", "operationId": "ConcatenateDocumentJobsV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two DocumentJobs to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatDocumentJobV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateDocumentJobs", "revision": 3 } } }, "/v4/api/DCP/ConcatenateDocumentJobs": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two DocumentJobs (V4)", "description": "Concatenate two DocumentJobs. Supported filetypes: pdf, docx.", "operationId": "ConcatenateDocumentJobsV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two DocumentJobs to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatDocumentJobV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateDocumentJobs", "revision": 4 } } }, "/v5/api/DCP/ConcatenateDocumentJobs": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two DocumentJobs", "description": "Concatenate two DocumentJobs. Supported filetypes: pdf, docx.", "operationId": "ConcatenateDocumentJobsV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two DocumentJobs to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatDocumentJobV5" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateDocumentJobs", "revision": 5 } } }, "/api/DCP/ConcatenateFiles": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two Files (pdf,docx)", "description": "Concatenates two supplied files (pdf,docx)", "operationId": "ConcatenateFiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two files to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatFiles" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateFiles", "revision": 1 } } }, "/v2/api/DCP/ConcatenateFiles": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two Document Contents or base64 encoded files (pdf,docx) (V2)", "description": "Concatenates two Document Contents or base64 encoded files (pdf,docx)", "operationId": "ConcatenateFilesV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two files to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatFilesV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateFiles", "revision": 2 } } }, "/v3/api/DCP/ConcatenateFiles": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two documents. Supported filetypes: pdf, docx", "description": "Concatenates two document contents or base64 encoded files. Supported filetypes: pdf,docx.", "operationId": "ConcatenateFilesV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two files to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatFilesV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateFiles", "revision": 3 } } }, "/v4/api/DCP/ConcatenateFiles": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two documents. Supported filetypes: pdf, docx", "description": "Concatenates two document contents or base64 encoded files. Supported filetypes: pdf,docx.", "operationId": "ConcatenateFilesV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two files to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatFilesV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateFiles", "revision": 4 } } }, "/v5/api/DCP/ConcatenateFiles": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Concatenate two documents. Supported filetypes: pdf, docx", "description": "Concatenates two document contents or base64 encoded files. Supported filetypes: pdf,docx.", "operationId": "ConcatenateFilesV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Information about the two files to combine", "required": true, "schema": { "$ref": "#/definitions/JSONConcatFilesV5" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "ConcatenateFiles", "revision": 5 } } }, "/api/DCP/CreateDocumentJob": { "post": { "tags": [ "DocumentGeneration" ], "summary": "Create document (sync)", "description": "This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds", "operationId": "CreateDocumentJob", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "TemplateId", "description": "Select the template for this DocumentJob", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "operationId": "GetAllTemplates" }, "x-ms-summary": "TemplateId" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "FileType", "description": "Select a filetype for the document result", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "value", "value-title": "key", "operationId": "GetFileTypes" }, "x-ms-summary": "FileType" }, { "in": "query", "name": "TimeOut", "description": "Max. time to wait for document", "type": "integer", "format": "int32", "default": 120, "x-ms-summary": "TimeOut" }, { "in": "query", "name": "UserId", "description": "Optional, supply Dynamics 365 users domain name or id", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsers" }, "x-ms-summary": "UserId" }, { "in": "query", "name": "SaveToSharepoint", "description": "Optional, save document to sharepoint", "type": "boolean", "default": false, "x-ms-summary": "SaveToSharepoint" }, { "in": "query", "name": "DCPPrinterName", "description": "Optional, Select the DCP printer for a PrintDocument operation", "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrinters" }, "x-ms-summary": "DCPPrinterName" }, { "in": "query", "name": "DeactivateOnTimeout", "description": "Deactivates the working item on a timeout, preventing the document generation", "type": "boolean", "default": false, "x-ms-summary": "DeactivateOnTimeout" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJob", "revision": 1 } } }, "/api/DCP/CreateDocumentJobAsync": { "post": { "tags": [ "DocumentGeneration" ], "summary": "Create DocumentJob (async)", "description": "This function creates a new DocumentJob.. Attention! The function does NOT wait for a result", "operationId": "CreateDocumentJobAsync", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "TemplateId", "description": "Select the template for this DocumentJob", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "operationId": "GetAllTemplates" }, "x-ms-summary": "TemplateId" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "FileType", "description": "Select a filetype for the document result", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "value", "value-title": "key", "operationId": "GetFileTypes" }, "x-ms-summary": "FileType" }, { "in": "query", "name": "UserId", "description": "Optional, the user to run this operation", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsers" }, "x-ms-summary": "UserId" }, { "in": "query", "name": "SaveToSharepoint", "description": "Optional, save document to sharepoint", "type": "boolean", "default": false, "x-ms-summary": "SaveToSharepoint" }, { "in": "query", "name": "DCPPrinterName", "description": "Optional, Select the printer for a PrintDocument operation", "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrinters" }, "x-ms-summary": "DCPPrinterName" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobAsync", "revision": 1 } } }, "/v2/api/DCP/CreateDocumentJobAsync": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "Create DocumentJob (async) (V2)", "description": "This function creates a new DocumentJob.. Attention! The function does NOT wait for a result", "operationId": "CreateDocumentJobAsyncV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "Template", "description": "Select the template for this DocumentJob", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "operationId": "GetAllTemplatesV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "Template" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "FileType", "description": "Select a filetype for the document result", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "value", "value-title": "key", "operationId": "GetFileTypes" }, "x-ms-summary": "FileType" }, { "in": "query", "name": "User", "description": "Optional, the user to run this operation", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" }, { "in": "query", "name": "SaveToSharepoint", "description": "Optional, save document to sharepoint", "type": "boolean", "default": false, "x-ms-summary": "SaveToSharepoint", "x-ms-visibility": "advanced" }, { "in": "query", "name": "DCPPrinterName", "description": "Optional, Select the printer for a PrintDocument operation", "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "DCPPrinterName", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEmailId", "description": "Specifies the email to attach the Job to", "type": "string", "format": "uuid", "x-ms-summary": "AttachToEmail", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEntityId", "description": "Specifies the entityId to attach the Job to", "type": "string", "format": "uuid", "x-ms-summary": "AttachToEntity", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEntitySchemaName", "description": "Specifies the entity schema name to attach the DocumentJob to", "type": "string", "x-ms-dynamic-values": { "value-path": "LogicalName", "value-title": "DisplayName", "operationId": "GetEntityNamesV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "AttachToEntity - SchemaName", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobAsync", "revision": 2 } } }, "/v3/api/DCP/CreateDocumentJobAsync": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Create DocumentJob (async) (V3)", "description": "Creates a new document. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/createdocumentjobasync", "operationId": "CreateDocumentJobAsyncV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV3" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobAsync", "revision": 3 } } }, "/v4/api/DCP/CreateDocumentJobAsync": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Create DocumentJob (async) (V4)", "description": "Creates a new document. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/createdocumentjobasync", "operationId": "CreateDocumentJobAsyncV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobAsync", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJobAsync": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Create DocumentJob (async)", "description": "Creates a new document. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/createdocumentjobasync", "operationId": "CreateDocumentJobAsyncV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobAsync", "revision": 5 } } }, "/v4/api/DCP/CreateDocumentJobMarketingAsync": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Process batch in customer journey (async) (V4)", "description": "Creates a new document. For more information https://short.mscrm-addons.com/createdocumentjob", "operationId": "CreateDocumentJobMarketingAsyncV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentMarketingBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobMarketingAsync", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJobMarketingAsync": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Process batch in customer journey (async)", "description": "Create and process documents in batch for records within a customer journey. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/customerjourneybatches", "operationId": "CreateDocumentJobMarketingAsyncV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentMarketingBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobMarketingAsync", "revision": 5 } } }, "/v4/api/DCP/CreateDocumentJobMarketing": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Process batch in customer journey (sync) (V4)", "description": "Creates a new document. For more information https://short.mscrm-addons.com/createdocumentjob", "operationId": "CreateDocumentJobMarketingV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentMarketingBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobMarketing", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJobMarketing": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Process batch in customer journey", "description": "Create and process documents in batch for records within a customer journey. For more information https://short.mscrm-addons.com/customerjourneybatches", "operationId": "CreateDocumentJobMarketingV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentMarketingBodyV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobMarketing", "revision": 5 } } }, "/v2/api/DCP/CreateDocumentJob": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "Create document (sync) (V2)", "description": "This function creates a new DocumentJob and waits for the result", "operationId": "CreateDocumentJobV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "Template", "description": "Select the template for this DocumentJob", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "operationId": "GetAllTemplatesV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "Template" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "FileType", "description": "Select a filetype for the document result", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "value", "value-title": "key", "operationId": "GetFileTypes" }, "x-ms-summary": "FileType" }, { "in": "query", "name": "User", "description": "Optional, supply Dynamics 365 users domain name or id", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" }, { "in": "query", "name": "SaveToSharepoint", "description": "Optional, save document to sharepoint", "type": "boolean", "default": false, "x-ms-summary": "SaveToSharepoint", "x-ms-visibility": "advanced" }, { "in": "query", "name": "DCPPrinterName", "description": "Optional, Select the DCP printer for a PrintDocument operation", "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "DCPPrinterName", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEmailId", "description": "Specifies the email to attach the Job to", "type": "string", "format": "uuid", "x-ms-summary": "AttachToEmail", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEntityId", "description": "Specifies the entityId to attach the Job to", "type": "string", "format": "uuid", "x-ms-summary": "AttachToEntity", "x-ms-visibility": "advanced" }, { "in": "query", "name": "AttachToEntitySchemaName", "description": "Specifies the entity schema name to attach the DocumentJob to", "type": "string", "x-ms-dynamic-values": { "value-path": "LogicalName", "value-title": "DisplayName", "operationId": "GetEntityNamesV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "AttachToEntity - SchemaName", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJob", "revision": 2 } } }, "/v3/api/DCP/CreateDocumentJob": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Create document (sync) (V3)", "description": "Creates a new document. For more information https://short.mscrm-addons.com/createdocumentjob", "operationId": "CreateDocumentJobV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV3" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJob", "revision": 3 } } }, "/v4/api/DCP/CreateDocumentJob": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Create document (sync) (V4)", "description": "Creates a new document. For more information https://short.mscrm-addons.com/createdocumentjob", "operationId": "CreateDocumentJobV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJob", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJob": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Create document", "description": "Creates a new document. For more information https://short.mscrm-addons.com/createdocumentjob", "operationId": "CreateDocumentJobV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateDocumentBodyV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJob", "revision": 5 } } }, "/api/DCP/CreateDocumentJobXmlBased": { "post": { "tags": [ "DocumentGeneration" ], "summary": "Create DocumentJob based on an XML (sync)", "description": "This function creates a new DocumentJob and waits for the result for up to [TimeOut] seconds", "operationId": "CreateDocumentJobXmlBased", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequest" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBased", "revision": 1 } } }, "/api/DCP/CreateDocumentJobXmlBasedAsync": { "post": { "tags": [ "DocumentGeneration" ], "summary": "Create DocumentJob based on an XML (async)", "description": "This function creates a new DocumentJob. Attention! The function does NOT wait for a result", "operationId": "CreateDocumentJobXmlBasedAsync", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequest" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBasedAsync", "revision": 1 } } }, "/v2/api/DCP/CreateDocumentJobXmlBasedAsync": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "Create DocumentJob based on an XML (async) (V2)", "description": "This function creates a new DocumentJob. Attention! The function does NOT wait for a result", "operationId": "CreateDocumentJobXmlBasedAsyncV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBasedAsync", "revision": 2 } } }, "/v3/api/DCP/CreateDocumentJobXmlBasedAsync": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Create Multipart document (async) (V3)", "description": "Create a document consisting of multiple components. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedAsyncV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBasedAsync", "revision": 3 } } }, "/v4/api/DCP/CreateDocumentJobXmlBasedAsync": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Create Multipart document (async) (V4)", "description": "Create a document consisting of multiple components. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedAsyncV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBasedAsync", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJobXmlBasedAsync": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Create Multipart DocumentJob (async)", "description": "Create a document consisting of multiple components. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedAsyncV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Multipart XML document for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONMultiPartRequestV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBasedAsync", "revision": 5 } } }, "/v2/api/DCP/CreateDocumentJobXmlBased": { "post": { "tags": [ "DocumentGenerationV2" ], "summary": "Create document based on an XML (sync) (V2)", "description": "This function creates a new DocumentJob and waits for the result", "operationId": "CreateDocumentJobXmlBasedV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV2" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBased", "revision": 2 } } }, "/v3/api/DCP/CreateDocumentJobXmlBased": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Create Multipart document (sync) (V3)", "description": "Create a document consisting of multiple components. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV3" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBased", "revision": 3 } } }, "/v4/api/DCP/CreateDocumentJobXmlBased": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Create Multipart document (sync) (V4)", "description": "Create a document consisting of multiple components. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Optional, Multipart XML document for the DocumentJob", "schema": { "$ref": "#/definitions/JSONMultiPartRequestV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBased", "revision": 4 } } }, "/v5/api/DCP/CreateDocumentJobXmlBased": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Create Multipart document", "description": "Create a document consisting of multiple components. For more information https://short.mscrm-addons.com/multipart", "operationId": "CreateDocumentJobXmlBasedV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Multipart XML document for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONMultiPartRequestV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateDocumentJobXmlBased", "revision": 5 } } }, "/v2/api/DCP/CreateSharepointFolder": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "CreateSharepointFolder (V2)", "description": "This function creates sharepoint folders", "operationId": "CreateSharepointFolderV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateSharepointFolders" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateSharepointFolder", "revision": 1 } } }, "/v3/api/DCP/CreateSharepointFolder": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Create SharePoint folder (V3)", "description": "Creates folders on SharePoint in the document location of a Dynamics 365 record.", "operationId": "CreateSharepointFolderV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateSharepointFoldersV3" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateSharepointFolder", "revision": 3 } } }, "/v4/api/DCP/CreateSharepointFolder": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Create SharePoint folder (V4)", "description": "Creates folders on SharePoint in the document location of a Dynamics 365 record.", "operationId": "CreateSharepointFolderV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateSharepointFoldersV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "CreateSharepointFolder", "revision": 4 } } }, "/v5/api/DCP/CreateSharepointFolder": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Create SharePoint folder", "description": "Creates folders on SharePoint in the document location of a Dynamics 365 record.", "operationId": "CreateSharepointFolderV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/JSONCreateSharepointFoldersV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "CreateSharepointFolder", "revision": 5 } } }, "/api/DCP/DocumentJobResult": { "get": { "tags": [ "DocumentGeneration" ], "summary": "Get DocumentJob Result", "description": "Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished", "operationId": "DocumentJobResult", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to retrieve the result of", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" }, { "in": "query", "name": "DeactivateOnTimeout", "description": "Deactivates the working item on a timeout, preventing the document generation", "type": "boolean", "default": false, "x-ms-summary": "DeactivateOnTimeout" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobResult", "revision": 1 } } }, "/v2/api/DCP/DocumentJobResult": { "get": { "tags": [ "DocumentGeneration V2" ], "summary": "Get DocumentJob Result (V2)", "description": "Retrieves a DocumentJobs status information. The result will include the result document, if the job is finished", "operationId": "DocumentJobResultV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "DocumentJobId", "description": "Guid of the DocumentJob Id to retrieve the result of", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobResult", "revision": 2 } } }, "/v3/api/DCP/DocumentJobResult": { "get": { "tags": [ "DocumentGeneration V3" ], "summary": "Get DocumentJob result (V3)", "description": "Retrieves status information of a DocumentJob. The result will include the generated document.", "operationId": "DocumentJobResultV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobResult", "revision": 3 } } }, "/v4/api/DCP/DocumentJobResult": { "get": { "tags": [ "DocumentGeneration V4" ], "summary": "Get DocumentJob result (V4)", "description": "Retrieves status information of a DocumentJob. The result will include the generated document.", "operationId": "DocumentJobResultV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobResult", "revision": 4 } } }, "/v5/api/DCP/DocumentJobResult": { "get": { "tags": [ "DocumentGeneration V5" ], "summary": "Get DocumentJob result", "description": "Retrieves status information of a DocumentJob. The result will include the generated document.", "operationId": "DocumentJobResultV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobResult", "revision": 5 } } }, "/api/DCP/DocumentJobStatus": { "get": { "tags": [ "DocumentGeneration" ], "summary": "Get DocumentJob Status", "description": "Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply", "operationId": "DocumentJobStatus", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to retrieve the status of", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" }, { "in": "query", "name": "DeactivateOnTimeout", "description": "Deactivates the working item on a timeout, preventing the document generation", "type": "boolean", "default": false, "x-ms-summary": "DeactivateOnTimeout" } ], "responses": { "200": { "description": "Returns an AutomergeWorkingItem", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobStatus", "revision": 1 } } }, "/v2/api/DCP/DocumentJobStatus": { "get": { "tags": [ "DocumentGeneration V2" ], "summary": "Get DocumentJob Status (V2)", "description": "Retrieves the status of a DocumentJob. Dynamics 365 state/statuscode rules apply", "operationId": "DocumentJobStatusV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "DocumentJobId", "description": "Guid of the DocumentJob Id to retrieve the status of", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" } ], "responses": { "200": { "description": "Returns an AutomergeWorkingItem", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobStatus", "revision": 2 } } }, "/v3/api/DCP/DocumentJobStatus": { "get": { "tags": [ "DocumentGeneration V3" ], "summary": "Get DocumentJob status (V3)", "description": "Retrieves the status of a DocumentJob.", "operationId": "DocumentJobStatusV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to retrieve the status of.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns an AutomergeWorkingItem", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobStatus", "revision": 3 } } }, "/v4/api/DCP/DocumentJobStatus": { "get": { "tags": [ "DocumentGeneration V4" ], "summary": "Get DocumentJob status (V4)", "description": "Retrieves the status of a DocumentJob.", "operationId": "DocumentJobStatusV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to retrieve the status of.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns an AutomergeWorkingItem", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobStatus", "revision": 4 } } }, "/v5/api/DCP/DocumentJobStatus": { "get": { "tags": [ "DocumentGeneration V5" ], "summary": "Get DocumentJob status", "description": "Retrieves the status of a DocumentJob.", "operationId": "DocumentJobStatusV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to retrieve the status of.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns an AutomergeWorkingItem", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "DocumentJobStatus", "revision": 5 } } }, "/api/DCP/GetAllTemplates": { "get": { "tags": [ "Metadata" ], "summary": "Get Templates", "description": "This function returns a list of available DocumentsCorePack Templates", "operationId": "GetAllTemplates", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "EntityName" }, { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "TemplateNameFilter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by group name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "GroupFilter" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsers" }, "x-ms-summary": "UserId" } ], "responses": { "200": { "description": "Returns a list of templates", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDCPTemplate" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetAllTemplates", "revision": 1 } } }, "/v2/api/DCP/GetAllTemplates": { "get": { "tags": [ "Metadata" ], "summary": "Get Templates", "description": "This function returns a list of available DocumentsCorePack Templates", "operationId": "GetAllTemplatesV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "EntityName" }, { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "TemplateNameFilter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by group name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "GroupFilter" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "envId" } } }, "x-ms-summary": "UserId" }, { "in": "query", "name": "envId", "description": "Specify Environment", "type": "integer", "format": "int32", "default": 0, "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of templates", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDCPTemplate" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetAllTemplates", "revision": 2 } } }, "/v3/api/DCP/GetAllTemplates": { "get": { "tags": [ "Metadata" ], "summary": "Get document templates", "description": "Retrieves a list of available DocumentsCorePack Templates.", "operationId": "GetAllTemplatesV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "Table Name" }, { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "Template Filter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by group name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "Group Filter" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User" }, { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of templates", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDCPTemplate" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetAllTemplates", "revision": 3 } } }, "/v4/api/DCP/GetAllTemplates": { "get": { "tags": [ "Metadata" ], "summary": "Get document templates", "description": "Retrieves a list of available DocumentsCorePack Templates.", "operationId": "GetAllTemplatesV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "Table Name" }, { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "Template Filter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by group name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "Group Filter" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User" }, { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of templates", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDCPTemplate" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "GetAllTemplates", "revision": 4 } } }, "/v2/api/DCP/GetApiKeyProfiles": { "get": { "tags": [ "Metadata" ], "summary": "Get Profiles for a UserAPIKey", "description": "This function returns all Profile Ids in Dynamics 365", "operationId": "GetApiKeyProfiles", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of Profile Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEnvironment" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetApiKeyProfiles", "revision": 2 } } }, "/v3/api/DCP/GetApiKeyProfiles": { "get": { "tags": [ "Metadata" ], "summary": "Get Profiles for a User APIKey", "description": "Retrieves all Profile Ids for this ApiKey.", "operationId": "GetApiKeyProfilesV3", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of Profile Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEnvironmentV3" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetApiKeyProfiles", "revision": 3 } } }, "/v4/api/DCP/GetApiKeyProfiles": { "get": { "tags": [ "Metadata" ], "summary": "Get Profiles for a User APIKey", "description": "Retrieves all Profile Ids for this ApiKey.", "operationId": "GetApiKeyProfilesV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of Profile Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEnvironmentV3" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "x-ms-api-annotation": { "status": "Production", "family": "GetApiKeyProfiles", "revision": 4 } } }, "/api/DCP/GetCombineTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP CombineTypes for DocumentConcatenation", "description": "This function returns a list of supported CombineTypes for DocumentsCorePack", "operationId": "GetCombineTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP CombineTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetCombineTypes", "revision": 1 } } }, "/v4/api/DCP/GetCombineTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP CombineTypes for DocumentConcatenation", "description": "This function returns a list of supported CombineTypes for DocumentsCorePack", "operationId": "GetCombineTypesV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP CombineTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetCombineTypes", "revision": 4 } } }, "/api/DCP/GetConcatenationOutputTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get Concatenation ResultTypes", "description": "This function returns a list of supported ResultTypes for Concatenation", "operationId": "GetConcatenationOutputTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetConcatenationOutputTypes", "revision": 1 } } }, "/v4/api/DCP/GetConcatenationOutputTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get Concatenation ResultTypes", "description": "This function returns a list of supported ResultTypes for Concatenation", "operationId": "GetConcatenationOutputTypesV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetConcatenationOutputTypes", "revision": 4 } } }, "/v4/api/DCP/GetCustomerJourneys": { "get": { "tags": [ "Metadata" ], "summary": "Get customer Journeys", "description": "Retrieves a list of available customer journeys.", "operationId": "GetCustomerJourneysV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityName", "description": "Journey based on entity", "type": "string", "x-ms-summary": "Table Name" }, { "in": "query", "name": "UserId", "description": "Only retrieve customer journeys accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User" }, { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of customer journeys", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONCustomerJourney" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetCustomerJourneys", "revision": 4 } } }, "/api/DCP/GetDCPActions": { "get": { "tags": [ "Metadata" ], "summary": "Available DCP Actions", "description": "This function returns a list of supported actions for DocumentsCorePack", "operationId": "GetDCPActions", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP Actions", "schema": { "type": "array", "items": { "$ref": "#/definitions/StringInt32KeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetDCPActions", "revision": 1 } } }, "/v4/api/DCP/GetDCPActions": { "get": { "tags": [ "Metadata" ], "summary": "Available DCP Actions", "description": "This function returns a list of supported actions for DocumentsCorePack", "operationId": "GetDCPActionsV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP Actions", "schema": { "type": "array", "items": { "$ref": "#/definitions/StringInt32KeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetDCPActions", "revision": 4 } } }, "/v3/api/DCP/GetDefaultEnvironment": { "get": { "tags": [ "Metadata" ], "summary": "Gets the Default Environment for this ApiKey", "description": "Returns the environment id for the used ApiKey.", "operationId": "GetApiKeyProfiles46", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns the default environment Ids", "schema": { "$ref": "#/definitions/JSONEnvironmentV3" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } }, "424": { "description": "returned for API Keys, that do not support a default environment", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true } }, "/v4/api/DCP/GetDefaultEnvironment": { "get": { "tags": [ "Metadata" ], "summary": "Gets the Default Environment for this ApiKey", "description": "Returns the environment id for the used ApiKey.", "operationId": "GetApiKeyProfiles68", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns the default environment Ids", "schema": { "$ref": "#/definitions/JSONEnvironmentV3" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } }, "424": { "description": "returned for API Keys, that do not support a default environment", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced" } }, "/api/DCP/GetDocumentLocations": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of DocumentLocations", "description": "list of dynamics users", "operationId": "GetDocumentLocations", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of dynamics DocumentLocations", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDocumentLocation" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetDocumentLocations", "revision": 1 } } }, "/v2/api/DCP/GetDocumentLocations": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of DocumentLocations", "description": "list of dynamics users", "operationId": "GetDocumentLocationsV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "description": "Specify Environment", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of dynamics DocumentLocations", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDocumentLocation" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetDocumentLocations", "revision": 2 } } }, "/v3/api/DCP/GetDocumentLocations": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of DocumentLocations", "description": "Retrieves a list of Dynamics DocumentLocations.", "operationId": "GetDocumentLocationsV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of dynamics DocumentLocations", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDocumentLocation" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetDocumentLocations", "revision": 3 } } }, "/v4/api/DCP/GetDocumentLocations": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of DocumentLocations", "description": "Retrieves a list of Dynamics DocumentLocations.", "operationId": "GetDocumentLocationsV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of dynamics DocumentLocations", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONDocumentLocation" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetDocumentLocations", "revision": 4 } } }, "/api/DCP/GetEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve EntityNames with annotation capability", "description": "This function returns a list of all Dynamics 365 entities, that support annotations", "operationId": "GetEntityNames", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetEntityNames", "revision": 1 } } }, "/v2/api/DCP/GetEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve EntityNames with annotation capability", "description": "This function returns a list of all Dynamics 365 entities, that support annotations", "operationId": "GetEntityNamesV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetEntityNames", "revision": 2 } } }, "/v3/api/DCP/GetEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve table names with annotation capability", "description": "Retrieve a list of Dynamics tables supporting annotations.", "operationId": "GetEntityNamesV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetEntityNames", "revision": 3 } } }, "/v4/api/DCP/GetEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve table names with annotation capability", "description": "Retrieve a list of Dynamics tables supporting annotations.", "operationId": "GetEntityNamesV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetEntityNames", "revision": 4 } } }, "/api/DCP/GetFileTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP FileTypes", "description": "This function returns a list of supported filetype for DocumentsCorePack", "operationId": "GetFileTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetFileTypes", "revision": 1 } } }, "/v4/api/DCP/GetFileTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP FileTypes", "description": "This function returns a list of supported filetype for DocumentsCorePack", "operationId": "GetFileTypesV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetFileTypes", "revision": 4 } } }, "/v4/api/DCP/GetMarketingEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve table names with marketing capability", "description": "Retrieve a list of Dynamics tables supporting marketing.", "operationId": "GetMarketingEntitiesV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetMarketingEntitiesV4", "revision": 4 } } }, "/v4/api/DCP/GetNoteEntityNames": { "get": { "tags": [ "Metadata" ], "summary": "Retrieve table names with annotation capability", "description": "Retrieve a list of Dynamics tables supporting annotations.", "operationId": "GetNoteEntityNamesV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of note-enabled Entities", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONEntityName" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetNoteEntityNames", "revision": 4 } } }, "/v2/api/DCP/GetOneClickActions": { "get": { "tags": [ "Metadata" ], "summary": "Get OneClickActions", "description": "This function returns all OneClickActions in Dynamics 365", "operationId": "GetOneClickActionsV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "description": "Specify Environment", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of OneClickActions", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONOneClickAction" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetOneClickActions", "revision": 2 } } }, "/v3/api/DCP/GetOneClickActions": { "get": { "tags": [ "Metadata" ], "summary": "Get One-Click-Actions", "description": "Retrieves all One-Click-Actions configured in Dynamics 365.", "operationId": "GetOneClickActionsV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of One-Click-Actions", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONOneClickAction" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetOneClickActions", "revision": 3 } } }, "/v4/api/DCP/GetOneClickActions": { "get": { "tags": [ "Metadata" ], "summary": "Get One-Click-Actions", "description": "Retrieves all One-Click-Actions configured in Dynamics 365.", "operationId": "GetOneClickActionsV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of One-Click-Actions", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONOneClickAction" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "GetOneClickActions", "revision": 4 } } }, "/api/DCP/GetPrinters": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP Printer", "description": "Retrieve available printer names, optionally filtered by user", "operationId": "GetPrinters", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "User", "description": "Optional, supply Dynamics 365 users domain name or id", "type": "string", "default": "", "x-ms-summary": "User" } ], "responses": { "200": { "description": "Returns a list of printers", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONPrinterResponse" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetPrinters", "revision": 1 } } }, "/v2/api/DCP/GetPrinters": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP Printer", "description": "Retrieve available printer names, optionally filtered by user", "operationId": "GetPrintersV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "description": "Specify Environment", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" }, { "in": "query", "name": "User", "description": "Optional, supply Dynamics 365 users domain name or id", "type": "string", "default": "", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "envId" } } }, "x-ms-summary": "User" } ], "responses": { "200": { "description": "Returns a list of printers", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONPrinterResponse" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetPrinters", "revision": 2 } } }, "/v3/api/DCP/GetPrinters": { "get": { "tags": [ "Metadata" ], "summary": "Get Printers", "description": "Retrieve available printers.", "operationId": "GetPrintersV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Optional, only list printers accessible to this user.", "type": "string", "default": "", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User" } ], "responses": { "200": { "description": "Returns a list of printers", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONPrinterResponse" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetPrinters", "revision": 3 } } }, "/v4/api/DCP/GetPrinters": { "get": { "tags": [ "Metadata" ], "summary": "Get Printers", "description": "Retrieve available printers.", "operationId": "GetPrintersV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Optional, only list printers accessible to this user.", "type": "string", "default": "", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User" } ], "responses": { "200": { "description": "Returns a list of printers", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONPrinterResponse" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "GetPrinters", "revision": 4 } } }, "/v2/api/DCP/GetSignProviders": { "get": { "tags": [ "Metadata" ], "summary": "Get SignProviders", "description": "This function returns all SignProviders known in the AutomergeSolution", "operationId": "GetSignProvidersV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "description": "Specify Environment", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of SignProviders", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSignProvider" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetSignProviders", "revision": 2 } } }, "/v3/api/DCP/GetSignProviders": { "get": { "tags": [ "Metadata" ], "summary": "Get e-signing providers", "description": "Retrieve all e-Signature providers available in DocumentsCorePack.", "operationId": "GetSignProvidersV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of SignProviders", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSignProvider" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetSignProviders", "revision": 3 } } }, "/v4/api/DCP/GetSignProviders": { "get": { "tags": [ "Metadata" ], "summary": "Get e-signing providers", "description": "Retrieve all e-Signature providers available in DocumentsCorePack.", "operationId": "GetSignProvidersV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of SignProviders", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSignProvider" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "advanced", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetSignProviders", "revision": 4 } } }, "/api/DCP/GetSingleTemplate": { "get": { "tags": [ "Metadata" ], "summary": "Get Single Template", "description": "This function returns the first of the filtered DocumentsCorePack Templates", "operationId": "GetSingleTemplate", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "TemplateNameFilter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by GroupName. Optional wildcard *[group]*", "type": "string", "x-ms-summary": "GroupFilter" }, { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "EntityName" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsers" }, "x-ms-summary": "UserId" } ], "responses": { "200": { "description": "Returns a single templates", "schema": { "$ref": "#/definitions/JSONDCPTemplate" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetSingleTemplate", "revision": 1 } } }, "/v4/api/DCP/GetSingleTemplate": { "get": { "tags": [ "Metadata" ], "summary": "Get Single Template", "description": "This function returns the first of the filtered DocumentsCorePack Templates", "operationId": "GetSingleTemplateV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "TemplateNameFilter", "description": "Filter by template name. Optional wildcard *[name]*", "type": "string", "x-ms-summary": "TemplateNameFilter" }, { "in": "query", "name": "GroupFilter", "description": "Filter by GroupName. Optional wildcard *[group]*", "type": "string", "x-ms-summary": "GroupFilter" }, { "in": "query", "name": "EntityName", "description": "Filter by Entity (etc or etn). Optional wildcard *[etn]*", "type": "string", "x-ms-summary": "EntityName" }, { "in": "query", "name": "UserId", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsers" }, "x-ms-summary": "UserId" } ], "responses": { "200": { "description": "Returns a single templates", "schema": { "$ref": "#/definitions/JSONDCPTemplate" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetSingleTemplate", "revision": 4 } } }, "/v4/api/DCP/GetSortDirections": { "get": { "tags": [ "Metadata" ], "summary": "Get sort directions", "description": "This function returns a list of sort direction options", "operationId": "GetSortDirections", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of sort direction options", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal" } }, "/api/DCP/GetUsers": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of dynamics users", "description": "list of dynamics users", "operationId": "GetUsers", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of dynamics users", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSystemUser" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetUsers", "revision": 1 } } }, "/v2/api/DCP/GetUsers": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of dynamics users", "description": "list of dynamics users", "operationId": "GetUsersV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "envId", "required": true, "type": "integer", "format": "int32", "x-ms-summary": "envId" } ], "responses": { "200": { "description": "Returns a list of dynamics users", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSystemUser" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetUsers", "revision": 2 } } }, "/v3/api/DCP/GetUsers": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of dynamics users", "description": "Retrieves a list of Dynamics users.", "operationId": "GetUsersV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of dynamics users", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSystemUser" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetUsers", "revision": 3 } } }, "/v4/api/DCP/GetUsers": { "get": { "tags": [ "Metadata" ], "summary": "Get a list of dynamics users", "description": "Retrieves a list of Dynamics users.", "operationId": "GetUsersV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose the Environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a list of dynamics users", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONSystemUser" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetUsers", "revision": 4 } } }, "/api/DCP/GetXmlBasedFileTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP FileTypes for XmlBased generation", "description": "This function returns a list of supported filetype for DocumentsCorePack XmlBased generation", "operationId": "GetXmlBasedFileTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes for XmlBased generation and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "GetXmlBasedFileTypes", "revision": 1 } } }, "/v4/api/DCP/GetXmlBasedFileTypes": { "get": { "tags": [ "Metadata" ], "summary": "Get DCP FileTypes for XmlBased generation", "description": "This function returns a list of supported filetype for DocumentsCorePack XmlBased generation", "operationId": "GetXmlBasedFileTypesV4", "produces": [ "application/json" ], "responses": { "200": { "description": "Returns a list of DCP FileTypes for XmlBased generation and their Ids", "schema": { "type": "array", "items": { "$ref": "#/definitions/JSONKeyValuePair" } } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "GetXmlBasedFileTypes", "revision": 4 } } }, "/api/DCP/Heartbeat": { "get": { "tags": [ "Maintenance" ], "summary": "Check API Availibility", "description": "Verifies, that the API endpoint is currently accessible. Does not require API Key", "operationId": "Heartbeat", "produces": [ "application/json" ], "responses": { "200": { "description": "returns message with timestamp", "schema": { "$ref": "#/definitions/UserMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Heartbeat", "revision": 1 } } }, "/v4/api/DCP/Heartbeat": { "head": { "tags": [ "Maintenance" ], "summary": "Check API Availability", "description": "Verifies, that the API endpoint is currently accessible. Does not require API Key", "operationId": "HeartbeatHeadV4", "produces": [ "application/json" ], "responses": { "200": { "description": "returns message with timestamp", "schema": { "$ref": "#/definitions/UserMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "HeartbeatHead", "revision": 4 } }, "get": { "tags": [ "Maintenance" ], "summary": "Check API Availability", "description": "Verifies, that the API endpoint is currently accessible. Does not require API Key", "operationId": "HeartbeatV4", "produces": [ "application/json" ], "responses": { "200": { "description": "returns message with timestamp", "schema": { "$ref": "#/definitions/UserMessage" } } }, "x-ms-visibility": "internal", "x-ms-api-annotation": { "status": "Production", "family": "Heartbeat", "revision": 4 } } }, "/v2/api/DCP/Heartbeat": { "get": { "tags": [ "Maintenance" ], "summary": "Check API Availibility", "description": "Verifies, that the API endpoint is currently accessible. Does not require API Key", "operationId": "HeartbeatV2", "produces": [ "application/json" ], "responses": { "200": { "description": "returns message with timestamp", "schema": { "$ref": "#/definitions/UserMessage" } } }, "x-ms-visibility": "internal", "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Heartbeat", "revision": 2 } } }, "/api/DCP/IsServiceAlive": { "get": { "tags": [ "Maintenance" ], "summary": "IsServiceAlive", "description": "returns true, if the service has been responsive recently, false, if not.", "operationId": "IsServiceAlive", "produces": [ "application/json" ], "responses": { "200": { "description": "returns a ServiceAlive variable of type bool", "schema": { "$ref": "#/definitions/UserMessage" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "IsServiceAlive", "revision": 1 } } }, "/api/DCP/ping": { "get": { "tags": [ "Maintenance" ], "summary": "Get connection details", "description": "Verifies, that the API endpoint is currently accessible. Does not require API Key", "operationId": "Ping", "produces": [ "application/json" ], "responses": { "200": { "description": "returns message with timestamp", "schema": { "$ref": "#/definitions/UserMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Ping", "revision": 1 } } }, "/api/DCP/PrintDocumentJob": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob", "description": "Print a Document generated by a DocumentJob. Attention! The documentjob must already be finished", "operationId": "PrintDocumentJob", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Guid of the DocumentJob Id to print", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" }, { "in": "query", "name": "DCPPrinterName", "description": "DCP Printername of the printer to use", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrinters" }, "x-ms-summary": "DCPPrinterName" }, { "in": "query", "name": "DeactivateOnTimeout", "description": "Deactivates the working item on a timeout, preventing the document generation", "type": "boolean", "default": false, "x-ms-summary": "DeactivateOnTimeout" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJob", "revision": 1 } } }, "/v5/api/DCP/PrintDocumentJobAsync": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob (async)", "description": "Print document generated by a DocumentJob. The action does NOT wait for a result.", "operationId": "PrintDocumentJobAsyncV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to print.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "DCPPrinterName", "description": "Choose printer.", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "Printer" }, { "in": "query", "name": "Copies", "description": "Number of document copies.", "type": "integer", "format": "int32", "x-ms-summary": "Print copies" }, { "in": "query", "name": "Environment", "description": "Choose environment.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJobAsync", "revision": 5 } } }, "/v2/api/DCP/PrintDocumentJob": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob (V2)", "description": "Print the Document Content generated by a DocumentJob. Attention! The documentjob must already be finished", "operationId": "PrintDocumentJobV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "DocumentJobId", "description": "Guid of the DocumentJob Id to print", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJobId" }, { "in": "query", "name": "DCPPrinterName", "description": "DCP Printername of the printer to use", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "DCPPrinterName" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJob", "revision": 2 } } }, "/v3/api/DCP/PrintDocumentJob": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob (V3)", "description": "Print document generated by a DocumentJob.", "operationId": "PrintDocumentJobV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to print.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "DCPPrinterName", "description": "Choose printer.", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "Printer" }, { "in": "query", "name": "Environment", "description": "Choose environment.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJob", "revision": 3 } } }, "/v4/api/DCP/PrintDocumentJob": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob (V4)", "description": "Print document generated by a DocumentJob.", "operationId": "PrintDocumentJobV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to print.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "DCPPrinterName", "description": "Choose printer.", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "Printer" }, { "in": "query", "name": "Copies", "description": "Number of document copies.", "type": "integer", "format": "int32", "x-ms-summary": "Print copies" }, { "in": "query", "name": "Environment", "description": "Choose environment.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJob", "revision": 4 } } }, "/v5/api/DCP/PrintDocumentJob": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print DocumentJob", "description": "Print document generated by a DocumentJob.", "operationId": "PrintDocumentJobV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "DocumentJobId", "description": "Unique identifier of the DocumentJob to print.", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "DocumentJob ID" }, { "in": "query", "name": "DCPPrinterName", "description": "Choose printer.", "required": true, "type": "string", "x-ms-dynamic-values": { "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "operationId": "GetPrintersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "Printer" }, { "in": "query", "name": "Copies", "description": "Number of document copies.", "type": "integer", "format": "int32", "x-ms-summary": "Print copies" }, { "in": "query", "name": "Environment", "description": "Choose environment.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "RequestSynchronousCallback", "description": "Use synchronous processing when accept/retry-after isn't supported.", "type": "boolean", "default": false, "x-ms-summary": "Sync. Callback", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "PrintDocumentJob", "revision": 5 } } }, "/api/DCP/PrintFile": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print File", "description": "Prints a base64 encoded file. Supported file-formats are PDF and DOCX", "operationId": "PrintFile", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequest" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintFile", "revision": 1 } } }, "/v5/api/DCP/PrintFileAsync": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print file (async)", "description": "Prints a document content or base64 encoded file. Supported filetypes: pdf, docx. The action does NOT wait for a result.", "operationId": "PrintFileAsyncV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequestV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "PrintFileAsync", "revision": 5 } } }, "/v2/api/DCP/PrintFile": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print File (V2)", "description": "Prints a Document Content or base64 encoded file. Supported file-formats are PDF and DOCX", "operationId": "PrintFileV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequestV2" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintFile", "revision": 2 } } }, "/v3/api/DCP/PrintFile": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print File (V3)", "description": "Prints a document content or base64 encoded file. Supported filetypes: pdf, docx.", "operationId": "PrintFileV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequestV3" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintFile", "revision": 3 } } }, "/v4/api/DCP/PrintFile": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print file (V4)", "description": "Prints a document content or base64 encoded file. Supported filetypes: pdf, docx.", "operationId": "PrintFileV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequestV4" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "PrintFile", "revision": 4 } } }, "/v5/api/DCP/PrintFile": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Print file", "description": "Prints a document content or base64 encoded file. Supported filetypes: pdf, docx.", "operationId": "PrintFileV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "File and Printer Information", "required": true, "schema": { "$ref": "#/definitions/JSONPrintDocumentRequestV5" } } ], "responses": { "200": { "description": "Returns a DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "PrintFile", "revision": 5 } } }, "/v2/api/DCP/RunOneClickActionAsync": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "Run OneClickAction (async) (V2)", "description": "This function runs a OneClickAction. Attention! The function does NOT wait for a result", "operationId": "RunOneClickActionAsyncV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "OneClickAction", "description": "Id of the OneClickAction to apply", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "OneClickAction" }, { "in": "query", "name": "User", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionAsync", "revision": 1 } } }, "/v3/api/DCP/RunOneClickActionAsync": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Run One-Click-Action (async) (V3)", "description": "Runs a One-Click-Action. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionAsyncV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionAsync", "revision": 3 } } }, "/v4/api/DCP/RunOneClickActionAsync": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Run One-Click-Action (async) (V4)", "description": "Runs a One-Click-Action. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionAsyncV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionAsync", "revision": 4 } } }, "/v5/api/DCP/RunOneClickActionAsync": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Run One-Click-Action (async)", "description": "Runs a One-Click-Action. The action does NOT wait for a result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionAsyncV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionAsync", "revision": 5 } } }, "/v2/api/DCP/RunOneClickActionSync": { "post": { "tags": [ "DocumentGeneration V2" ], "summary": "Run OneClickAction (sync) (V2)", "description": "This function runs a OneClickAction and waits for the result", "operationId": "RunOneClickActionSyncV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" }, { "in": "query", "name": "EntityId", "description": "Dynamics 365 source record id", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "EntityId" }, { "in": "query", "name": "OneClickAction", "description": "Id of the OneClickAction to apply", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "OneClickAction" }, { "in": "query", "name": "User", "description": "Only retrieve templates accessible to this user", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV2", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionSync", "revision": 1 } } }, "/v3/api/DCP/RunOneClickActionSync": { "post": { "tags": [ "DocumentGeneration V3" ], "summary": "Run One-Click-Action (sync) (V3)", "description": "Runs a One-Click-Action and waits for the result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionSyncV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV3", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionSync", "revision": 3 } } }, "/v4/api/DCP/RunOneClickActionSync": { "post": { "tags": [ "DocumentGeneration V4" ], "summary": "Run One-Click-Action (sync) (V4)", "description": "Runs a One-Click-Action and waits for the result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionSyncV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickActionSync", "revision": 4 } } }, "/v5/api/DCP/RunOneClickAction": { "post": { "tags": [ "DocumentGeneration V5" ], "summary": "Run One-Click-Action", "description": "Runs a One-Click-Action and waits for the result. For more information https://short.mscrm-addons.com/oca", "operationId": "RunOneClickActionSyncV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "EntityId", "description": "Unique identifier of the record to run the One-Click-Action for", "required": true, "type": "string", "format": "uuid", "x-ms-summary": "Row ID" }, { "in": "query", "name": "OneClickAction", "description": "Unique identifier of the One-Click-Action to apply.", "required": true, "type": "string", "format": "uuid", "x-ms-dynamic-values": { "value-path": "OcaID", "value-title": "DisplayName", "operationId": "GetOneClickActionsV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "One-Click-Action ID" }, { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment", "x-ms-visibility": "advanced" }, { "in": "query", "name": "User", "description": "Only retrieve One-Click-Actions accessible to this user.", "type": "string", "x-ms-dynamic-values": { "value-path": "systemuserid", "value-title": "fullname", "operationId": "GetUsersV4", "parameters": { "Environment": { "parameter": "Environment" } } }, "x-ms-summary": "User", "x-ms-visibility": "advanced" }, { "in": "query", "name": "RequestSynchronousCallback", "description": "Use synchronous processing when accept/retry-after isn't supported.", "type": "boolean", "default": false, "x-ms-summary": "Sync. Callback", "x-ms-visibility": "advanced" } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "RunOneClickAction", "revision": 5 } } }, "/api/DCP/SendEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Send email", "description": "Send the specified email", "operationId": "SendEmail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "ID of email to send", "schema": { "$ref": "#/definitions/JSONSendEmail" } } ], "responses": { "200": { "description": "Returns an DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "SendEmail", "revision": 1 } } }, "/v2/api/DCP/SendEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Send email (V2)", "description": "Send the specified email", "operationId": "SendEmailV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "ID of email to send", "required": true, "schema": { "$ref": "#/definitions/JSONSendEmailV2" } } ], "responses": { "200": { "description": "Returns an DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "SendEmail", "revision": 2 } } }, "/v3/api/DCP/SendEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Send email (V3)", "description": "Send Dataverse email.", "operationId": "SendEmailV3", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "ID of email to send", "required": true, "schema": { "$ref": "#/definitions/JSONSendEmailV3" } } ], "responses": { "200": { "description": "Returns an DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "SendEmail", "revision": 3 } } }, "/v4/api/DCP/SendEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Send email (V4)", "description": "Send Dataverse email.", "operationId": "SendEmailV4", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "ID of email to send", "required": true, "schema": { "$ref": "#/definitions/JSONSendEmailV4" } } ], "responses": { "200": { "description": "Returns an DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "SendEmail", "revision": 4 } } }, "/v5/api/DCP/SendEmail": { "post": { "tags": [ "DocumentFunctions" ], "summary": "Send email", "description": "Send Dataverse email.", "operationId": "SendEmailV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "ID of email to send", "required": true, "schema": { "$ref": "#/definitions/JSONSendEmailV5" } } ], "responses": { "200": { "description": "Returns an DocumentJob", "schema": { "$ref": "#/definitions/DocumentJobStatusResponse" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "SendEmail", "revision": 5 } } }, "/v5/api/DCP/SignDocumentJobCollection": { "post": { "tags": [ "Signing" ], "summary": "Sign DocumentJob Collection", "description": "Send documents for e-signing.", "operationId": "SignDocumentJobCollectionV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Signing metadata for the DocumentJob Collection", "required": true, "schema": { "$ref": "#/definitions/JSONSignDocumentJobCollectionV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "SignDocumentJobCollection", "revision": 5 } } }, "/v2/api/DCP/SignDocumentJob": { "post": { "tags": [ "Signing" ], "summary": "Sign DocumentJob based on an XML (sync) (V2)", "description": "This function digitally signs a DocumentJob and waits for the result", "operationId": "SignDocumentJob", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Signing metadata for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONSignDocument" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Signing", "revision": 1 } } }, "/v3/api/DCP/SignDocumentJob": { "post": { "tags": [ "Signing" ], "summary": "Sign DocumentJob (sync) (V3)", "description": "Send a document for e-signing.", "operationId": "SignDocumentJob84", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Signing metadata for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONSignDocumentV3" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Signing", "revision": 2 } } }, "/v4/api/DCP/SignDocumentJob": { "post": { "tags": [ "Signing" ], "summary": "Sign DocumentJob (sync) (V4)", "description": "Send a document for e-signing.", "operationId": "SignDocumentJob125", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Signing metadata for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONSignDocumentV4" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "Signing", "revision": 4 } } }, "/v5/api/DCP/SignDocumentJob": { "post": { "tags": [ "Signing" ], "summary": "Sign DocumentJob", "description": "Send a document for e-signing.", "operationId": "SignDocumentJobV5", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Signing metadata for the DocumentJob", "required": true, "schema": { "$ref": "#/definitions/JSONSignDocumentJobV5" } } ], "responses": { "200": { "description": "Returns a document", "schema": { "$ref": "#/definitions/DocumentJobResponseV2" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "400": { "description": "returned for all other errors", "schema": { "$ref": "#/definitions/ErrorMessage" } } }, "x-ms-api-annotation": { "status": "Production", "family": "Signing", "revision": 5 } } }, "/api/DCP/whoami": { "get": { "tags": [ "Maintenance" ], "summary": "WhoAmI", "description": "Returns information about the currently used API Key and assoicated Service", "operationId": "WhoAmI", "produces": [ "application/json" ], "responses": { "200": { "description": "returns ApiKey and ApiOwner name", "schema": { "$ref": "#/definitions/WhoAmi" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "WhoAmI", "revision": 1 } } }, "/v2/api/DCP/whoami": { "get": { "tags": [ "Maintenance" ], "summary": "WhoAmI (V2)", "description": "Returns information about the currently used API Key and associated Service", "operationId": "WhoAmIV2", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Specifies the connection to use for a perUser APIKey", "required": true, "type": "integer", "format": "int32", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfiles" }, "x-ms-summary": "Environment" } ], "responses": { "200": { "description": "returns ApiKey and ApiOwner name", "schema": { "$ref": "#/definitions/WhoAmi" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "WhoAmI", "revision": 2 } } }, "/v3/api/DCP/whoami": { "get": { "tags": [ "Maintenance" ], "summary": "WhoAmI (V3)", "description": "Retrieve information about the used API Key and associated DocumentsCorePack Service.", "operationId": "WhoAmIV3", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment" } ], "responses": { "200": { "description": "returns ApiKey and ApiOwner name", "schema": { "$ref": "#/definitions/WhoAmi" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "WhoAmI", "revision": 3 } } }, "/v4/api/DCP/whoami": { "get": { "tags": [ "Maintenance" ], "summary": "WhoAmI (V4)", "description": "Retrieve information about the used API Key and associated DocumentsCorePack Service.", "operationId": "WhoAmIV4", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV3" }, "x-ms-summary": "Environment" } ], "responses": { "200": { "description": "returns ApiKey and ApiOwner name", "schema": { "$ref": "#/definitions/WhoAmi" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } } }, "deprecated": true, "x-ms-api-annotation": { "status": "Production", "family": "WhoAmI", "revision": 4 } } }, "/v5/api/DCP/whoami": { "get": { "tags": [ "Maintenance" ], "summary": "Who am I", "description": "Retrieve information about the used API Key and associated DocumentsCorePack Service.", "operationId": "WhoAmIV5", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Environment", "description": "Choose environment for this operation.", "type": "string", "default": "(default)", "x-ms-dynamic-values": { "value-path": "EnvironmentId", "value-title": "EnvironmentName", "operationId": "GetApiKeyProfilesV4" }, "x-ms-summary": "Environment" } ], "responses": { "200": { "description": "returns ApiKey and ApiOwner name", "schema": { "$ref": "#/definitions/WhoAmiV5" } }, "401": { "description": "returned for invalid API Key", "schema": { "$ref": "#/definitions/ProblemDetails" } } }, "x-ms-api-annotation": { "status": "Production", "family": "WhoAmI", "revision": 5 } } } }, "definitions": { "JSONAttachDocumentJobToEmail": { "required": [ "DocumentJobId", "EmailId" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "The DocumentJob ID of the generated document to attach to the email", "x-ms-summary": "DocumentJobId" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "EmailId": { "type": "string", "description": "The email the document should be attached to" } } }, "DocumentJobStatusResponse": { "type": "object", "properties": { "Success": { "type": "boolean", "readOnly": true }, "Return value": { "type": "string" }, "Return value 2": { "type": "string" }, "DocumentJobId": { "type": "string" } } }, "ProblemDetails": { "type": "object", "additionalProperties": { "type": "object" } }, "ErrorMessage": { "type": "object", "properties": { "Success": { "type": "boolean", "readOnly": true }, "Return value": { "type": "string" }, "Return value 2": { "type": "string" } } }, "JSONAttachDocumentJobToEmailV2": { "required": [ "DocumentJobId", "EmailId", "Environment" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "DocumentJobId": { "type": "string", "description": "The DocumentJob ID of the generated document to attach to the email", "x-ms-summary": "DocumentJobId" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "EmailId": { "type": "string", "description": "The email the document should be attached to" } } }, "JSONAttachDocumentJobToEmailV3": { "required": [ "DocumentJobId", "EmailId" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the email.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachDocumentJobToEmailV4": { "required": [ "DocumentJobId", "EmailId" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the email.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachDocumentJobToEmailV5": { "required": [ "DocumentJobId", "EmailId" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the email.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachDocumentJobToNote": { "required": [ "DocumentJobId", "Entity Id", "Schemaname" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "The DocumentJob ID of the generated document to attach to the note", "x-ms-summary": "DocumentJobId" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNames", "value-path": "LogicalName", "value-title": "DisplayName" }, "description": "The schemaname of the entity to attach the note to", "x-ms-summary": "Schemaname" }, "Note description": { "type": "string", "description": "Set this text as Notes description", "x-ms-summary": "Description" }, "Note subject": { "type": "string", "description": "Set this text as Notes subjects", "x-ms-summary": "Subject" }, "Entity Id": { "type": "string", "description": "The Guid of the entity to attach the note to", "x-ms-summary": "RegardingObjectId" } } }, "JSONCreateNoteResponse": { "type": "object", "properties": { "annotationid": { "type": "string" }, "Success": { "type": "boolean", "readOnly": true }, "Return value": { "type": "string" }, "Return value 2": { "type": "string" } } }, "JSONAttachDocumentJobToNoteV2": { "required": [ "DocumentJobId", "EntityId", "Environment", "Schemaname" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "DocumentJobId": { "type": "string", "description": "The DocumentJob ID of the generated document to attach to the note", "x-ms-summary": "DocumentJobId" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV2", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetEntityNamesV2", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "envId": { "parameterReference": "body/Environment" } } } }, "Description": { "type": "string", "description": "Set this text as Notes description", "x-ms-summary": "Note description" }, "Subject": { "type": "string", "description": "Set this text as Notes subjects", "x-ms-summary": "Note subject" }, "EntityId": { "type": "string", "description": "The Guid of the entity to attach the note to", "x-ms-summary": "Entity Id" } } }, "JSONAttachDocumentJobToNoteV3": { "required": [ "DocumentJobId", "EntityId", "Schemaname" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the note.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONAttachDocumentJobToNoteV4": { "required": [ "DocumentJobId", "EntityId", "Schemaname" ], "type": "object", "properties": { "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the note.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetNoteEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetNoteEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONAttachDocumentJobToNoteV5": { "required": [ "DocumentJobId", "EntityId", "Schemaname" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "DocumentJobId": { "type": "string", "description": "Unique identifier of the DocumentJob to attach to the note.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetNoteEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetNoteEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONAttachFileToEmail": { "required": [ "Document (base64)", "EmailId", "Filename" ], "type": "object", "properties": { "Document (base64)": { "type": "string", "description": "A base64 encoded string representing the files content", "x-ms-summary": "Document (base64)" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "Mime-Type": { "type": "string", "description": "Content mime-type for handling of the file (e.g. application/text)", "x-ms-summary": "Mime-Type" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "EmailId": { "type": "string", "description": "The email the document should be attached to" } } }, "JSONAttachFileToEmailV2": { "required": [ "base64", "EmailId", "Environment", "Filename" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content", "x-ms-summary": "Document content" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "MimeType": { "type": "string", "description": "Content mime-type for handling of the file (e.g. application/text)", "x-ms-summary": "Mime-Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "EmailId": { "type": "string", "description": "The email the document should be attached to" } } }, "JSONAttachFileToEmailV3": { "required": [ "base64", "EmailId", "Filename" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Filename of the attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "MIME type of the attachment (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } } }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachFileToEmailV4": { "required": [ "base64", "EmailId", "Filename" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Filename of the attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "MIME type of the attachment (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachFileToEmailV5": { "required": [ "base64", "EmailId", "Filename" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Filename of the attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "MIME type of the attachment (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the Environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "EmailId": { "type": "string", "description": "Unique identifier of the email the document should be attached to.", "x-ms-summary": "Email ID" } } }, "JSONAttachFileToNote": { "required": [ "Document (base64)", "Entity Id", "Filename", "Schemaname" ], "type": "object", "properties": { "Document (base64)": { "type": "string", "description": "A base64 encoded string representing the files content", "x-ms-summary": "Document (base64)" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "Mime-Type": { "type": "string", "description": "Content mime-type for handling of the file (e.g. application/text)", "x-ms-summary": "Mime-Type" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNames", "value-path": "LogicalName", "value-title": "DisplayName" }, "description": "The schemaname of the entity to attach the note to", "x-ms-summary": "Schemaname" }, "Note description": { "type": "string", "description": "Set this text as Notes description", "x-ms-summary": "Description" }, "Note subject": { "type": "string", "description": "Set this text as Notes subjects", "x-ms-summary": "Subject" }, "Entity Id": { "type": "string", "description": "The Guid of the entity to attach the note to", "x-ms-summary": "RegardingObjectId" } } }, "JSONAttachFileToNoteV2": { "required": [ "base64", "EntityId", "Environment", "Filename", "Schemaname" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content", "x-ms-summary": "Document content" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "MimeType": { "type": "string", "description": "Content mime-type for handling of the file (e.g. application/text)", "x-ms-summary": "Mime-Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV2", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetEntityNamesV2", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "envId": { "parameterReference": "body/Environment" } } } }, "Description": { "type": "string", "description": "Set this text as Notes description", "x-ms-summary": "Note description" }, "Subject": { "type": "string", "description": "Set this text as Notes subjects", "x-ms-summary": "Note subject" }, "EntityId": { "type": "string", "description": "The Guid of the entity to attach the note to", "x-ms-summary": "Entity Id" } } }, "JSONAttachFileToNoteV3": { "required": [ "base64", "EntityId", "Filename", "Schemaname" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "File name of the note attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "Content MIME type for handling of the file (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONAttachFileToNoteV4": { "required": [ "base64", "EntityId", "Filename", "Schemaname" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "File name of the note attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "Content MIME type for handling of the file (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetNoteEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetNoteEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONAttachFileToNoteV5": { "required": [ "base64", "EntityId", "Filename", "Schemaname" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "File name of the note attachment.", "x-ms-summary": "File Name" }, "MimeType": { "type": "string", "description": "Content MIME type for handling of the file (e.g. application/pdf).", "x-ms-summary": "MIME Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetNoteEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach the note to.", "x-ms-dynamic-list": { "operationId": "GetNoteEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "Description": { "type": "string", "description": "Text of the note.", "x-ms-summary": "Note Description" }, "Subject": { "type": "string", "description": "Subject of the note.", "x-ms-summary": "Note Subject" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to attach the note to.", "x-ms-summary": "Row ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONConcatDocumentJob": { "required": [ "CombineType", "First DocumentJob", "OutputFileType", "Second DocumentJob" ], "type": "object", "properties": { "First DocumentJob": { "format": "uuid", "type": "string", "description": "First DocumentJobId of ConcatenationJob", "x-ms-summary": "First DocumentJob" }, "Second DocumentJob": { "format": "uuid", "type": "string", "description": "Second DocumentJobId of ConcatenationJob", "x-ms-summary": "Second DocumentJob" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Select how the files should be combined", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Select a filetype for the concationation result", "x-ms-summary": "OutputFileType" } } }, "DocumentJobResponse": { "type": "object", "properties": { "File name": { "type": "string" }, "File size": { "format": "int32", "type": "integer" }, "Document (Base64 encoded)": { "type": "string" }, "Mime-Type": { "type": "string" }, "Temporary Record Id": { "type": "string" }, "Success": { "type": "boolean", "readOnly": true }, "Return value": { "type": "string" }, "Return value 2": { "type": "string" }, "DocumentJobId": { "type": "string" } } }, "JSONConcatDocumentJobV2": { "required": [ "CombineType", "DocumentJob1", "DocumentJob2", "Environment", "OutputFileType" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "DocumentJob1": { "format": "uuid", "type": "string", "description": "First DocumentJobId of ConcatenationJob", "x-ms-summary": "First DocumentJob" }, "DocumentJob2": { "format": "uuid", "type": "string", "description": "Second DocumentJobId of ConcatenationJob", "x-ms-summary": "Second DocumentJob" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Select how the files should be combined", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Select a filetype for the concationation result", "x-ms-summary": "OutputFileType" } } }, "DocumentJobResponseV2": { "type": "object", "properties": { "File name": { "type": "string" }, "File size": { "format": "int32", "type": "integer" }, "Document content": { "type": "string", "format": "byte" }, "Mime-Type": { "type": "string" }, "Temporary Record Id": { "type": "string" }, "Success": { "type": "boolean", "readOnly": true }, "Return value": { "type": "string" }, "Return value 2": { "type": "string" }, "DocumentJobId": { "type": "string" } } }, "JSONConcatDocumentJobV3": { "required": [ "CombineType", "DocumentJob1", "DocumentJob2", "OutputFileType" ], "type": "object", "properties": { "DocumentJob1": { "format": "uuid", "type": "string", "description": "Unique identifier of the first DocumentJob.", "x-ms-summary": "First DocumentJob ID" }, "DocumentJob2": { "format": "uuid", "type": "string", "description": "Unique identifier of the second DocumentJob.", "x-ms-summary": "Second DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Choose combination type." }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONConcatDocumentJobV4": { "required": [ "CombineType", "DocumentJob1", "DocumentJob2", "OutputFileType" ], "type": "object", "properties": { "DocumentJob1": { "format": "uuid", "type": "string", "description": "Unique identifier of the first DocumentJob.", "x-ms-summary": "First DocumentJob ID" }, "DocumentJob2": { "format": "uuid", "type": "string", "description": "Unique identifier of the second DocumentJob.", "x-ms-summary": "Second DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose combination type.", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONConcatDocumentJobV5": { "required": [ "CombineType", "DocumentJob1", "DocumentJob2", "OutputFileType" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "DocumentJob1": { "format": "uuid", "type": "string", "description": "Unique identifier of the first DocumentJob.", "x-ms-summary": "First DocumentJob ID" }, "DocumentJob2": { "format": "uuid", "type": "string", "description": "Unique identifier of the second DocumentJob.", "x-ms-summary": "Second DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose combination type.", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONConcatFiles": { "required": [ "CombineType", "First Document (base64)", "First Filename", "First Mime-Type", "OutputFileType", "Second Document (base64)", "Second Filename", "Second Mime-Type" ], "type": "object", "properties": { "First Filename": { "type": "string", "description": "The filename of the first document", "x-ms-summary": "First Filename" }, "First Mime-Type": { "type": "string", "description": "Content mime-type for handling of the first document (e.g. application/pdf)", "x-ms-summary": "First Mime-Type" }, "First Document (base64)": { "type": "string", "description": "A base64 encoded string representing the first document content", "x-ms-summary": "First Document (base64)" }, "Second Filename": { "type": "string", "description": "The filename of the second document", "x-ms-summary": "Second Filename" }, "Second Mime-Type": { "type": "string", "description": "Content mime-type for handling of the second document (e.g. application/pdf)", "x-ms-summary": "Second Mime-Type" }, "Second Document (base64)": { "type": "string", "description": "A base64 encoded string representing the second document content", "x-ms-summary": "Second Document (base64)" }, "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "UserId": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "UserId" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Select how the files should be combined", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Select a filetype for the concationation result", "x-ms-summary": "OutputFileType" } } }, "JSONConcatFilesV2": { "required": [ "base64_1", "base64_2", "CombineType", "Environment", "FileName_1", "FileName_2", "MimeType_1", "MimeType_2", "OutputFileType" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation" }, "FileName_1": { "type": "string", "description": "The filename of the first document", "x-ms-summary": "First Filename" }, "MimeType_1": { "type": "string", "description": "Content mime-type for handling of the first document (e.g. application/pdf)", "x-ms-summary": "First Mime-Type" }, "base64_1": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content", "x-ms-summary": "First Document content" }, "FileName_2": { "type": "string", "description": "The filename of the second document", "x-ms-summary": "Second Filename" }, "MimeType_2": { "type": "string", "description": "Content mime-type for handling of the second document (e.g. application/pdf)", "x-ms-summary": "Second Mime-Type" }, "base64_2": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content", "x-ms-summary": "Second Document content" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Select how the files should be combined", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Select a filetype for the concationation result", "x-ms-summary": "OutputFileType" } } }, "JSONConcatFilesV3": { "required": [ "base64_1", "base64_2", "CombineType", "FileName_1", "FileName_2", "MimeType_1", "MimeType_2", "OutputFileType" ], "type": "object", "properties": { "FileName_1": { "type": "string", "description": "Filename of the first document.", "x-ms-summary": "First Filename" }, "MimeType_1": { "type": "string", "description": "MIME type of the first document (e.g. application/pdf).", "x-ms-summary": "First Mime-Type" }, "base64_1": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "First Document Content" }, "FileName_2": { "type": "string", "description": "Filename of the second document.", "x-ms-summary": "Second Filename" }, "MimeType_2": { "type": "string", "description": "MIME type of the second document (e.g. application/pdf).", "x-ms-summary": "Second Mime-Type" }, "base64_2": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Second Document Content" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypes", "value-path": "value", "value-title": "key" }, "description": "Choose combination type." }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypes", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONConcatFilesV4": { "required": [ "base64_1", "base64_2", "CombineType", "FileName_1", "FileName_2", "MimeType_1", "MimeType_2", "OutputFileType" ], "type": "object", "properties": { "FileName_1": { "type": "string", "description": "Filename of the first document.", "x-ms-summary": "First Filename" }, "MimeType_1": { "type": "string", "description": "MIME type of the first document (e.g. application/pdf).", "x-ms-summary": "First Mime-Type" }, "base64_1": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "First Document Content" }, "FileName_2": { "type": "string", "description": "Filename of the second document.", "x-ms-summary": "Second Filename" }, "MimeType_2": { "type": "string", "description": "MIME type of the second document (e.g. application/pdf).", "x-ms-summary": "Second Mime-Type" }, "base64_2": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Second Document Content" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose combination type.", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONConcatFilesV5": { "required": [ "base64_1", "base64_2", "CombineType", "FileName_1", "FileName_2", "MimeType_1", "MimeType_2", "OutputFileType" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "FileName_1": { "type": "string", "description": "Filename of the first document.", "x-ms-summary": "First Filename" }, "MimeType_1": { "type": "string", "description": "MIME type of the first document (e.g. application/pdf).", "x-ms-summary": "First Mime-Type" }, "base64_1": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "First Document Content" }, "FileName_2": { "type": "string", "description": "Filename of the second document.", "x-ms-summary": "Second Filename" }, "MimeType_2": { "type": "string", "description": "MIME type of the second document (e.g. application/pdf).", "x-ms-summary": "Second Mime-Type" }, "base64_2": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Second Document Content" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" }, "CombineType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetCombineTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose combination type.", "x-ms-summary": "CombineType" }, "OutputFileType": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetConcatenationOutputTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype for the result.", "x-ms-summary": "Output filetype" } } }, "JSONUserPrompt": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name/Id of the prompt.", "x-ms-summary": "Name" }, "Value": { "type": "string", "description": "Value of the prompt.", "x-ms-summary": "Value" }, "IsValid": { "type": "boolean", "readOnly": true } } }, "JSONUserPrompts": { "type": "object", "properties": { "UserPrompts": { "type": "array", "items": { "$ref": "#/definitions/JSONUserPrompt" }, "x-ms-visibility": "advanced", "x-ms-summary": "Prompt" } } }, "JSONCreateDocumentBodyV3": { "required": [ "EntityId", "FileType", "Template" ], "type": "object", "properties": { "Template": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetAllTemplatesV3", "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose template for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetAllTemplatesV3", "itemValuePath": "ptm_mscrmaddons_dcptemplatesid", "itemTitlePath": "ptm_name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Template" }, "EntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to run this template for.", "x-ms-summary": "Row ID" }, "FileType": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetFileTypes", "value-path": "value", "value-title": "key" }, "description": "Choose filetype.", "x-ms-summary": "File Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToSharepoint": { "type": "boolean", "description": "Save the document to SharePoint.", "x-ms-visibility": "advanced", "x-ms-summary": "Save to SharePoint" }, "AttachToEmailId": { "format": "uuid", "type": "string", "description": "Unique identifier of the email to attach the document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to Email" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV3", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetPrintersV3", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "AttachToEntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to attach this document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to [Row ID]" }, "AttachToEntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach this document to.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Attach to [Table]" }, "UserPrompts": { "$ref": "#/definitions/JSONUserPrompts" }, "JSONDataSource": { "type": "string", "description": "Use this JSON data for document creation.", "x-ms-visibility": "advanced", "x-ms-summary": "JSON Datasource" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateDocumentBodyV4": { "required": [ "EntityId", "FileType", "Template" ], "type": "object", "properties": { "Template": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetAllTemplatesV4", "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose template for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetAllTemplatesV4", "itemValuePath": "ptm_mscrmaddons_dcptemplatesid", "itemTitlePath": "ptm_name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Template" }, "EntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to run this template for.", "x-ms-summary": "Row ID" }, "FileType": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetFileTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype.", "x-ms-summary": "File Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToSharepoint": { "type": "boolean", "description": "Save the document to SharePoint.", "x-ms-visibility": "advanced", "x-ms-summary": "Save to SharePoint" }, "AttachToEmailId": { "format": "uuid", "type": "string", "description": "Unique identifier of the email to attach the document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to Email" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "AttachToEntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to attach this document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to [Row ID]" }, "AttachToEntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach this document to.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Attach to [Table]" }, "UserPrompts": { "$ref": "#/definitions/JSONUserPrompts" }, "JSONDataSource": { "type": "string", "description": "Use this JSON data for document creation.", "x-ms-visibility": "advanced", "x-ms-summary": "JSON Datasource" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateDocumentMarketingBodyV4": { "required": [ "EntityId", "EntitySchemaName", "FileType", "Journey", "Template" ], "type": "object", "properties": { "EntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetMarketingEntitiesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to run this document for.", "x-ms-dynamic-list": { "operationId": "GetMarketingEntitiesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "[Table]" }, "EntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to run this template for.", "x-ms-summary": "Row ID" }, "Template": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetAllTemplatesV4", "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "parameters": { "EntityName": { "parameter": "EntitySchemaName" }, "Environment": { "parameter": "Environment" } } }, "description": "Choose template for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetAllTemplatesV4", "itemValuePath": "ptm_mscrmaddons_dcptemplatesid", "itemTitlePath": "ptm_name", "parameters": { "EntityName": { "parameterReference": "body/EntitySchemaName" }, "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Template" }, "Journey": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetCustomerJourneysV4", "value-path": "msdynmkt_journeyid", "value-title": "msdynmkt_name", "parameters": { "EntityName": { "parameter": "EntitySchemaName" }, "Environment": { "parameter": "Environment" } } }, "description": "Choose customer journey for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetCustomerJourneysV4", "itemValuePath": "msdynmkt_journeyid", "itemTitlePath": "msdynmkt_name", "parameters": { "EntityName": { "parameterReference": "body/EntitySchemaName" }, "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Journey" }, "FileType": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetXmlBasedFileTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype.", "x-ms-summary": "File Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToSharepoint": { "type": "boolean", "description": "Save the document to SharePoint.", "x-ms-visibility": "advanced", "x-ms-summary": "Save to SharePoint" }, "BatchDelay": { "format": "int32", "maximum": 24, "minimum": 0, "type": "integer", "description": "Interval between document processes in hours.", "x-ms-visibility": "advanced", "x-ms-summary": "BatchDelay" }, "BatchSize": { "format": "int32", "maximum": 5000, "minimum": 0, "type": "integer", "description": "Number of items required to trigger the document processing.", "x-ms-visibility": "advanced", "x-ms-summary": "BatchSize" }, "SortField": { "type": "string", "description": "Specify a sort value for the records in the document.", "x-ms-visibility": "advanced", "x-ms-summary": "Sort column" }, "SortDirection": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSortDirections", "value-path": "value", "value-title": "key" }, "description": "Sort column order.", "x-ms-visibility": "advanced", "x-ms-summary": "Sort Direction" }, "SaveLocationUri": { "type": "string", "description": "Set a custom save location (Blob or Sharepoint).", "x-ms-visibility": "advanced", "x-ms-summary": "Save location" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "PrintCopies": { "format": "int32", "type": "integer", "description": "Number of document copies.", "x-ms-visibility": "advanced", "x-ms-summary": "Print copies" }, "AttachToEntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to attach this document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to [Row ID]" }, "AttachToEntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach this document to.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Attach to [Table]" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateDocumentMarketingBodyV5": { "required": [ "EntityId", "EntitySchemaName", "FileType", "Journey", "Template" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "EntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetMarketingEntitiesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to run this document for.", "x-ms-dynamic-list": { "operationId": "GetMarketingEntitiesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "[Table]" }, "EntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to run this template for.", "x-ms-summary": "Row ID" }, "Template": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetAllTemplatesV4", "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "parameters": { "EntityName": { "parameter": "EntitySchemaName" }, "Environment": { "parameter": "Environment" } } }, "description": "Choose template for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetAllTemplatesV4", "itemValuePath": "ptm_mscrmaddons_dcptemplatesid", "itemTitlePath": "ptm_name", "parameters": { "EntityName": { "parameterReference": "body/EntitySchemaName" }, "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Template" }, "Journey": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetCustomerJourneysV4", "value-path": "msdynmkt_journeyid", "value-title": "msdynmkt_name", "parameters": { "EntityName": { "parameter": "EntitySchemaName" }, "Environment": { "parameter": "Environment" } } }, "description": "Choose customer journey for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetCustomerJourneysV4", "itemValuePath": "msdynmkt_journeyid", "itemTitlePath": "msdynmkt_name", "parameters": { "EntityName": { "parameterReference": "body/EntitySchemaName" }, "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Journey" }, "FileType": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetXmlBasedFileTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype.", "x-ms-summary": "File Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToSharepoint": { "type": "boolean", "description": "Save the document to SharePoint.", "x-ms-visibility": "advanced", "x-ms-summary": "Save to SharePoint" }, "BatchDelay": { "format": "int32", "maximum": 24, "minimum": 0, "type": "integer", "description": "Interval between document processes in hours.", "x-ms-visibility": "advanced", "x-ms-summary": "BatchDelay" }, "BatchSize": { "format": "int32", "maximum": 5000, "minimum": 0, "type": "integer", "description": "Number of items required to trigger the document processing.", "x-ms-visibility": "advanced", "x-ms-summary": "BatchSize" }, "SortField": { "type": "string", "description": "Specify a sort value for the records in the document.", "x-ms-visibility": "advanced", "x-ms-summary": "Sort column" }, "SortDirection": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSortDirections", "value-path": "value", "value-title": "key" }, "description": "Sort column order.", "x-ms-visibility": "advanced", "x-ms-summary": "Sort Direction" }, "SaveLocationUri": { "type": "string", "description": "Set a custom save location (Blob or Sharepoint).", "x-ms-visibility": "advanced", "x-ms-summary": "Save location" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "PrintCopies": { "format": "int32", "type": "integer", "description": "Number of document copies.", "x-ms-visibility": "advanced", "x-ms-summary": "Print copies" }, "AttachToEntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to attach this document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to [Row ID]" }, "AttachToEntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach this document to.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Attach to [Table]" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateDocumentBodyV5": { "required": [ "EntityId", "FileType", "Template" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "Template": { "format": "uuid", "type": "string", "x-ms-dynamic-values": { "operationId": "GetAllTemplatesV4", "value-path": "ptm_mscrmaddons_dcptemplatesid", "value-title": "ptm_name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose template for this DocumentJob.", "x-ms-dynamic-list": { "operationId": "GetAllTemplatesV4", "itemValuePath": "ptm_mscrmaddons_dcptemplatesid", "itemTitlePath": "ptm_name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Template" }, "EntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to run this template for.", "x-ms-summary": "Row ID" }, "FileType": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetFileTypesV4", "value-path": "value", "value-title": "key" }, "description": "Choose filetype.", "x-ms-summary": "File Type" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToSharepoint": { "type": "boolean", "description": "Save the document to SharePoint.", "x-ms-visibility": "advanced", "x-ms-summary": "Save to SharePoint" }, "AttachToEmailId": { "format": "uuid", "type": "string", "description": "Unique identifier of the email to attach the document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to Email" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "AttachToEntityId": { "format": "uuid", "type": "string", "description": "Unique identifier of the record to attach this document to.", "x-ms-visibility": "advanced", "x-ms-summary": "Attach to [Row ID]" }, "AttachToEntitySchemaName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose table to attach this document to.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Attach to [Table]" }, "UserPrompts": { "$ref": "#/definitions/JSONUserPrompts" }, "JSONDataSource": { "type": "string", "description": "Use this JSON data for document creation.", "x-ms-visibility": "advanced", "x-ms-summary": "JSON Datasource" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONMultiPartRequest": { "required": [ "MultiPartXml" ], "type": "object", "properties": { "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "TimeOut": { "format": "int32", "type": "integer", "description": "Timeout for document creation", "x-ms-summary": "TimeOut" }, "MultiPartXml": { "type": "string", "description": "Multipart XML document for the DocumentJob", "x-ms-summary": "MultiPartXml" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-visibility": "advanced", "x-ms-summary": "User" } } }, "JSONMultiPartRequestV2": { "required": [ "Environment", "MultiPartXml" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation", "x-ms-summary": "Environment" }, "MultiPartXml": { "type": "string", "description": "Multipart XML document for the DocumentJob", "x-ms-summary": "MultiPartXml" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" } } }, "JSONMultiPartRequestV3": { "required": [ "MultiPartXml" ], "type": "object", "properties": { "MultiPartXml": { "type": "string", "description": "Multipart XML definition for the DocumentJob.", "x-ms-summary": "Multipart XML" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToTempRecord": { "type": "boolean", "description": "Save only in alternative location.", "x-ms-visibility": "advanced", "x-ms-summary": "Use External Storage" }, "SaveLocation": { "type": "string", "description": "External SharePoint or Blob URL.", "x-ms-visibility": "advanced", "x-ms-summary": "Save Location" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONMultiPartRequestV4": { "required": [ "MultiPartXml" ], "type": "object", "properties": { "MultiPartXml": { "type": "string", "description": "Multipart XML definition for the DocumentJob.", "x-ms-summary": "Multipart XML" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToTempRecord": { "type": "boolean", "description": "Save only in alternative location.", "x-ms-visibility": "advanced", "x-ms-summary": "Use External Storage" }, "SaveLocation": { "type": "string", "description": "External SharePoint or Blob URL.", "x-ms-visibility": "advanced", "x-ms-summary": "Save Location" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONMultiPartRequestV5": { "required": [ "MultiPartXml" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "MultiPartXml": { "type": "string", "description": "Multipart XML definition for the DocumentJob.", "x-ms-summary": "Multipart XML" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SaveToTempRecord": { "type": "boolean", "description": "Save only in alternative location.", "x-ms-visibility": "advanced", "x-ms-summary": "Use External Storage" }, "SaveLocation": { "type": "string", "description": "External SharePoint or Blob URL.", "x-ms-visibility": "advanced", "x-ms-summary": "Save Location" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateSharepointFolders": { "required": [ "EntityId", "Environment", "Schemaname" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation", "x-ms-summary": "Environment" }, "FolderNames": { "type": "array", "items": { "type": "string" }, "description": "Supply all foldernames to create", "x-ms-summary": "Folder name enumeration" }, "EntityId": { "type": "string", "description": "The Guid of the entity to create the folders for", "x-ms-summary": "RegardingObjectId" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV2", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "envId": { "parameter": "Environment" } } }, "description": "The schemaname of the entity to create the folders for", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV2", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Dynamics Schemaname" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "DocumentLocation": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetDocumentLocationsV2", "value-path": "sharepointdocumentlocationid", "value-title": "name", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetDocumentLocationsV2", "itemValuePath": "sharepointdocumentlocationid", "itemTitlePath": "name", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "DocumentLocation" } } }, "JSONCreateSharepointFoldersV3": { "required": [ "EntityId", "Schemaname" ], "type": "object", "properties": { "FolderNames": { "type": "array", "items": { "type": "string" }, "description": "Supply all foldernames to create.", "x-ms-summary": "Folder Names" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to create the folders for.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Tablename of the record to create the folders for.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "DocumentLocation": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetDocumentLocationsV3", "value-path": "sharepointdocumentlocationid", "value-title": "name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose a document location to create the folders in.", "x-ms-dynamic-list": { "operationId": "GetDocumentLocationsV3", "itemValuePath": "sharepointdocumentlocationid", "itemTitlePath": "name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "DocumentLocation ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateSharepointFoldersV4": { "required": [ "EntityId", "Schemaname" ], "type": "object", "properties": { "FolderNames": { "type": "array", "items": { "type": "string" }, "description": "Supply all foldernames to create.", "x-ms-summary": "Folder Names" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to create the folders for.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Tablename of the record to create the folders for.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "DocumentLocation": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetDocumentLocationsV4", "value-path": "sharepointdocumentlocationid", "value-title": "name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose a document location to create the folders in.", "x-ms-dynamic-list": { "operationId": "GetDocumentLocationsV4", "itemValuePath": "sharepointdocumentlocationid", "itemTitlePath": "name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "DocumentLocation ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONCreateSharepointFoldersV5": { "required": [ "EntityId", "Schemaname" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "FolderNames": { "type": "array", "items": { "type": "string" }, "description": "Supply all foldernames to create.", "x-ms-summary": "Folder Names" }, "EntityId": { "type": "string", "description": "Unique identifier of the record to create the folders for.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Tablename of the record to create the folders for.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "DocumentLocation": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetDocumentLocationsV4", "value-path": "sharepointdocumentlocationid", "value-title": "name", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose a document location to create the folders in.", "x-ms-dynamic-list": { "operationId": "GetDocumentLocationsV4", "itemValuePath": "sharepointdocumentlocationid", "itemTitlePath": "name", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "DocumentLocation ID" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONDCPTemplate": { "type": "object", "properties": { "ptm_mscrmaddons_dcptemplatesid": { "type": "string" }, "ptm_name": { "type": "string" }, "ptm_entitytype": { "type": "string" } } }, "JSONEnvironment": { "type": "object", "properties": { "EnvironmentName": { "type": "string" }, "EnvironmentId": { "format": "int32", "type": "integer" } } }, "JSONEnvironmentV3": { "type": "object", "properties": { "EnvironmentName": { "type": "string" }, "EnvironmentId": { "type": "string" } } }, "JSONKeyValuePair": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "format": "int32", "type": "integer" } } }, "JSONCustomerJourney": { "type": "object", "properties": { "msdynmkt_journeyid": { "type": "string" }, "msdynmkt_name": { "type": "string" } } }, "StringInt32KeyValuePair": { "type": "object", "properties": { "Key": { "type": "string", "readOnly": true }, "Value": { "format": "int32", "type": "integer", "readOnly": true } } }, "JSONDocumentLocation": { "type": "object", "properties": { "sharepointdocumentlocationid": { "type": "string" }, "name": { "type": "string" } } }, "JSONEntityName": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "LogicalName": { "type": "string" } } }, "JSONOneClickAction": { "type": "object", "properties": { "DisplayName": { "type": "string", "readOnly": true }, "OcaID": { "format": "uuid", "type": "string", "readOnly": true }, "@odata.etag": { "type": "string" }, "ptm_entity": { "type": "string" }, "ptm_position": { "format": "int32", "type": "integer" }, "_owningbusinessunit_value": { "type": "string" }, "ptm_mscrmaddonscomoneclickactionid": { "type": "string" }, "ptm_name": { "type": "string" }, "statecode": { "format": "int32", "type": "integer" }, "statuscode": { "format": "int32", "type": "integer" }, "_createdby_value": { "type": "string" }, "ptm_oca": { "type": "string" }, "_ownerid_value": { "type": "string" }, "modifiedon": { "format": "date-time", "type": "string" }, "_owninguser_value": { "type": "string" }, "_modifiedby_value": { "type": "string" }, "versionnumber": { "format": "int32", "type": "integer" }, "createdon": { "format": "date-time", "type": "string" }, "_ptm_groupid_value": { "type": "string" } } }, "JSONPrinterResponse": { "type": "object", "properties": { "DCPPrinterName": { "type": "string" } } }, "JSONSignProvider": { "type": "object", "properties": { "SignProviderName": { "type": "string" }, "OptionValue": { "format": "int64", "type": "integer" } } }, "JSONSystemUser": { "type": "object", "properties": { "systemuserid": { "type": "string" }, "fullname": { "type": "string" }, "domainname": { "type": "string" }, "azureactivedirectoryobjectid": { "type": "string" } } }, "UserMessage": { "type": "object", "properties": { "Message": { "type": "string" } } }, "JSONPrintDocumentRequest": { "required": [ "DCPPrinterName", "Document (base64)", "Filename" ], "type": "object", "properties": { "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "Document (base64)": { "type": "string", "description": "A base64 encoded string representing the files content", "x-ms-summary": "Document (base64)" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrinters", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName" }, "x-ms-summary": "Printer" } } }, "JSONPrintDocumentRequestV4": { "required": [ "base64", "DCPPrinterName", "Filename" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Choose filename.", "x-ms-summary": "File Name" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "PrintCopies": { "format": "int32", "type": "integer", "description": "Number of document copies.", "x-ms-summary": "Print copies" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONPrintDocumentRequestV2": { "required": [ "base64", "DCPPrinterName", "Environment", "Filename" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation", "x-ms-summary": "Environment" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content", "x-ms-summary": "Document content" }, "Filename": { "type": "string", "description": "The filename to use for storing the file", "x-ms-summary": "Filename" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV2", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetPrintersV2", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" } } }, "JSONPrintDocumentRequestV3": { "required": [ "base64", "DCPPrinterName", "Filename" ], "type": "object", "properties": { "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Choose filename.", "x-ms-summary": "File Name" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV3", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-dynamic-list": { "operationId": "GetPrintersV3", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONPrintDocumentRequestV5": { "required": [ "base64", "DCPPrinterName", "Filename" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "base64": { "type": "string", "format": "byte", "description": "A content-object or base64 encoded string representing the files content.", "x-ms-summary": "Document Content" }, "Filename": { "type": "string", "description": "Choose filename.", "x-ms-summary": "File Name" }, "DCPPrinterName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetPrintersV4", "value-path": "DCPPrinterName", "value-title": "DCPPrinterName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose printer.", "x-ms-dynamic-list": { "operationId": "GetPrintersV4", "itemValuePath": "DCPPrinterName", "itemTitlePath": "DCPPrinterName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Printer" }, "PrintCopies": { "format": "int32", "type": "integer", "description": "Number of document copies.", "x-ms-summary": "Print copies" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONLookup": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNames", "value-path": "LogicalName", "value-title": "DisplayName" } } } }, "JSONSendEmail": { "required": [ "EmailToSend" ], "type": "object", "properties": { "DeactivateOnTimeout": { "type": "boolean", "description": "Deactivates the working item on a timeout, preventing the document generation", "default": false, "x-ms-summary": "DeactivateOnTimeout" }, "EmailToSend": { "type": "string", "description": "Guid of email to send", "x-ms-summary": "EmailToSend" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsers", "value-path": "systemuserid", "value-title": "fullname" }, "x-ms-summary": "User" }, "Sender (userid)": { "format": "uuid", "type": "string", "description": "Guid of email sender", "x-ms-summary": "Sender (userid)" }, "Sender (Schemaname)": { "type": "string", "description": "Schema name of the sender, default is systemuser", "default": "systemuser", "x-ms-summary": "Sender (Schemaname)" }, "Regarding (Id)": { "format": "uuid", "type": "string", "description": "Guid of the entity to set as regarding", "x-ms-summary": "Regarding (Id)" }, "Regarding (Schemaname)": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNames", "value-path": "LogicalName", "value-title": "DisplayName" }, "x-ms-summary": "Regarding (Schemaname)" }, "To": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails TO recipient list", "x-ms-summary": "To" }, "CC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails CC recipient list", "x-ms-summary": "CC" }, "BCC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails BCC recipient list", "x-ms-summary": "BCC" } } }, "JSONSendEmailV2": { "required": [ "EmailToSend", "Environment" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation", "x-ms-summary": "Environment" }, "EmailToSend": { "type": "string", "description": "Guid of email to send", "x-ms-summary": "EmailToSend" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SenderId": { "format": "uuid", "type": "string", "description": "Guid of email sender", "x-ms-summary": "Sender (userid)" }, "SenderLogicalName": { "type": "string", "description": "Schema name of the sender, default is systemuser", "default": "systemuser", "x-ms-summary": "Sender (Schemaname)" }, "RegardingObjectId": { "format": "uuid", "type": "string", "description": "Guid of the entity to set as regarding", "x-ms-summary": "Regarding (Id)" }, "RegardingObjectLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV2", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-dynamic-list": { "operationId": "GetEntityNamesV2", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Regarding (Schemaname)" }, "To": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails TO recipient list", "x-ms-summary": "To" }, "CC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails CC recipient list", "x-ms-summary": "CC" }, "BCC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookup" }, "description": "The emails BCC recipient list", "x-ms-summary": "BCC" } } }, "JSONLookupV3": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNames", "value-path": "LogicalName", "value-title": "DisplayName" }, "x-ms-summary": "Table Name" } } }, "JSONSendEmailV3": { "required": [ "EmailToSend" ], "type": "object", "properties": { "EmailToSend": { "type": "string", "description": "Unique identifier of the email to send.", "x-ms-summary": "Email to Send" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SenderId": { "format": "uuid", "type": "string", "description": "Unique identifier of email sender.", "x-ms-summary": "Sender (Row ID)" }, "SenderLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the sender, default is systemuser.", "default": "systemuser", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Sender (Table Name)" }, "RegardingObjectId": { "format": "uuid", "type": "string", "description": "Unique identifier of the table to set as regarding.", "x-ms-summary": "Regarding (Row ID)" }, "RegardingObjectLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name to set as regarding.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Regarding (Table Name)" }, "To": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV3" }, "description": "The emails TO recipient list.", "x-ms-summary": "To" }, "CC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV3" }, "description": "The emails CC recipient list.", "x-ms-summary": "CC" }, "BCC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV3" }, "description": "The emails BCC recipient list.", "x-ms-summary": "BCC" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONLookupV4": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName" }, "x-ms-summary": "Table Name" } } }, "JSONSendEmailV4": { "required": [ "EmailToSend" ], "type": "object", "properties": { "EmailToSend": { "type": "string", "description": "Unique identifier of the email to send.", "x-ms-summary": "Email to Send" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SenderId": { "format": "uuid", "type": "string", "description": "Unique identifier of email sender.", "x-ms-summary": "Sender (Row ID)" }, "SenderLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the sender, default is systemuser.", "default": "systemuser", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Sender (Table Name)" }, "RegardingObjectId": { "format": "uuid", "type": "string", "description": "Unique identifier of the table to set as regarding.", "x-ms-summary": "Regarding (Row ID)" }, "RegardingObjectLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name to set as regarding.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Regarding (Table Name)" }, "To": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails TO recipient list.", "x-ms-summary": "To" }, "CC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails CC recipient list.", "x-ms-summary": "CC" }, "BCC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails BCC recipient list.", "x-ms-summary": "BCC" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONSendEmailV5": { "required": [ "EmailToSend" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "EmailToSend": { "type": "string", "description": "Unique identifier of the email to send.", "x-ms-summary": "Email to Send" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SenderId": { "format": "uuid", "type": "string", "description": "Unique identifier of email sender.", "x-ms-summary": "Sender (Row ID)" }, "SenderLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the sender, default is systemuser.", "default": "systemuser", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Sender (Table Name)" }, "RegardingObjectId": { "format": "uuid", "type": "string", "description": "Unique identifier of the table to set as regarding.", "x-ms-summary": "Regarding (Row ID)" }, "RegardingObjectLogicalName": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name to set as regarding.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Regarding (Table Name)" }, "To": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails TO recipient list.", "x-ms-summary": "To" }, "CC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails CC recipient list.", "x-ms-summary": "CC" }, "BCC": { "type": "array", "items": { "$ref": "#/definitions/JSONLookupV4" }, "description": "The emails BCC recipient list.", "x-ms-summary": "BCC" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "SignatureProvider": { "type": "object", "properties": { "Name": { "type": "string", "description": "TBD.", "x-ms-visibility": "advanced" }, "Uses": { "type": "string", "description": "TBD.", "x-ms-visibility": "advanced" } } }, "Signee": { "required": [ "Email", "InPerson", "Name" ], "type": "object", "properties": { "Name": { "type": "string", "description": "The display name of the Signee." }, "Email": { "type": "string", "description": "The email address of the Signee." }, "InPerson": { "type": "boolean", "description": "Generates a link to start the signing process.", "x-ms-visibility": "advanced", "x-ms-summary": "InPerson" }, "Subject": { "type": "string", "description": "Personalized subject in signing request email.", "x-ms-visibility": "advanced" }, "Message": { "type": "string", "description": "Personalized message in signing request email.", "x-ms-visibility": "advanced" }, "TelNr": { "type": "string", "description": "Signees telephone number for SMS authentication (DocuSign only).", "x-ms-visibility": "advanced", "x-ms-summary": "Telephonenumber" }, "HostName": { "type": "string", "description": "Signing hosts name for inPerson signing (DocuSign only).", "x-ms-visibility": "advanced", "x-ms-summary": "DocuSign Hostname" }, "Hostemail": { "type": "string", "description": "Signing hosts emailaddress for inPerson signing (DocuSign only).", "x-ms-visibility": "advanced" }, "AccessCode": { "type": "string", "description": "TBD.", "x-ms-visibility": "advanced" }, "HasAccessCode": { "type": "boolean", "description": "TBD.", "x-ms-visibility": "advanced" }, "OTP": { "type": "string", "description": "TBD.", "x-ms-visibility": "advanced" }, "HasSMSAuth": { "type": "boolean", "description": "TBD.", "x-ms-visibility": "advanced" }, "SignatureProvider": { "$ref": "#/definitions/SignatureProvider" } } }, "JSONSignDocumentJobCollectionV5": { "required": [ "DocumentJobCollection", "EntityId", "Schemaname", "SignProvider" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "EntityId": { "type": "string", "description": "Unique identifier of the record the eSign record will be attached to.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the record the eSign record will be attached to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "DocumentJobCollection": { "type": "array", "items": { "format": "uuid", "type": "string" }, "description": "Unique identifiers of DocumentJobs to sign.", "x-ms-summary": "DocumentJob ID Collection" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SignProvider": { "format": "int64", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSignProvidersV4", "value-path": "OptionValue", "value-title": "SignProviderName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose e-Signature provider.", "x-ms-dynamic-list": { "operationId": "GetSignProvidersV4", "itemValuePath": "OptionValue", "itemTitlePath": "SignProviderName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Signing Provider" }, "Subject": { "type": "string", "description": "Default subject in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Subject" }, "Message": { "type": "string", "description": "Default message in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Message" }, "Signees": { "type": "array", "items": { "$ref": "#/definitions/Signee" }, "x-ms-summary": "Signee" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONSignDocument": { "required": [ "DocumentJob", "EntityId", "Environment", "Schemaname", "SignProvider" ], "type": "object", "properties": { "Environment": { "format": "int32", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfiles", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Select the Environment for his operation", "x-ms-summary": "Environment" }, "EntityId": { "type": "string", "description": "The Guid of the Entity the eSign record wil be attached to", "x-ms-summary": "EntityId" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV2", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "envId": { "parameter": "Environment" } } }, "description": "The Schemaname of the Entity the eSign record wil be attached to", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV2", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Schemaname" }, "DocumentJob": { "format": "uuid", "type": "string", "description": "DocumentJobId containing the document to sign", "x-ms-summary": "DocumentJob" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV2", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "envId": { "parameter": "Environment" } } }, "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV2", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SignProvider": { "format": "int64", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSignProvidersV2", "value-path": "OptionValue", "value-title": "SignProviderName", "parameters": { "envId": { "parameter": "Environment" } } }, "description": "The provider that should be used to sign this document", "x-ms-dynamic-list": { "operationId": "GetSignProvidersV2", "itemValuePath": "OptionValue", "itemTitlePath": "SignProviderName", "parameters": { "envId": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Signing Provider" }, "Subject": { "type": "string", "description": "Default subject in signing request email", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Subject" }, "Message": { "type": "string", "description": "Default message in signing request email", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Message" }, "Signees": { "type": "array", "items": { "$ref": "#/definitions/Signee" }, "x-ms-summary": "Signees" } } }, "JSONSignDocumentV3": { "required": [ "DocumentJob", "EntityId", "Schemaname", "SignProvider" ], "type": "object", "properties": { "EntityId": { "type": "string", "description": "Unique identifier of the record the eSign record will be attached to.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV3", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the record the eSign record will be attached to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV3", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "DocumentJob": { "format": "uuid", "type": "string", "description": "Unique identifier of the DocumentJob to sign.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV3", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV3", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SignProvider": { "format": "int64", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSignProvidersV3", "value-path": "OptionValue", "value-title": "SignProviderName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose e-Signature provider.", "x-ms-dynamic-list": { "operationId": "GetSignProvidersV3", "itemValuePath": "OptionValue", "itemTitlePath": "SignProviderName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Signing Provider" }, "Subject": { "type": "string", "description": "Default subject in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Subject" }, "Message": { "type": "string", "description": "Default message in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Message" }, "Signees": { "type": "array", "items": { "$ref": "#/definitions/Signee" }, "x-ms-summary": "Signee" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV3", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONSignDocumentV4": { "required": [ "DocumentJob", "EntityId", "Schemaname", "SignProvider" ], "type": "object", "properties": { "EntityId": { "type": "string", "description": "Unique identifier of the record the eSign record will be attached to.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the record the eSign record will be attached to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "DocumentJob": { "format": "uuid", "type": "string", "description": "Unique identifier of the DocumentJob to sign.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SignProvider": { "format": "int64", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSignProvidersV4", "value-path": "OptionValue", "value-title": "SignProviderName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose e-Signature provider.", "x-ms-dynamic-list": { "operationId": "GetSignProvidersV4", "itemValuePath": "OptionValue", "itemTitlePath": "SignProviderName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Signing Provider" }, "Subject": { "type": "string", "description": "Default subject in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Subject" }, "Message": { "type": "string", "description": "Default message in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Message" }, "Signees": { "type": "array", "items": { "$ref": "#/definitions/Signee" }, "x-ms-summary": "Signee" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "JSONSignDocumentJobV5": { "required": [ "DocumentJob", "EntityId", "Schemaname", "SignProvider" ], "type": "object", "properties": { "RequestSynchronousCallback": { "type": "boolean", "description": "Use synchronous processing when accept/retry-after isn't supported.", "default": false, "x-ms-visibility": "advanced", "x-ms-summary": "Sync. Callback" }, "EntityId": { "type": "string", "description": "Unique identifier of the record the eSign record will be attached to.", "x-ms-summary": "Row ID" }, "Schemaname": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetEntityNamesV4", "value-path": "LogicalName", "value-title": "DisplayName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Table name of the record the eSign record will be attached to.", "x-ms-dynamic-list": { "operationId": "GetEntityNamesV4", "itemValuePath": "LogicalName", "itemTitlePath": "DisplayName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Table Name" }, "DocumentJob": { "format": "uuid", "type": "string", "description": "Unique identifier of the DocumentJob to sign.", "x-ms-summary": "DocumentJob ID" }, "User": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetUsersV4", "value-path": "systemuserid", "value-title": "fullname", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose the user to run this operation.", "x-ms-visibility": "advanced", "x-ms-dynamic-list": { "operationId": "GetUsersV4", "itemValuePath": "systemuserid", "itemTitlePath": "fullname", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "User" }, "SignProvider": { "format": "int64", "type": "integer", "x-ms-dynamic-values": { "operationId": "GetSignProvidersV4", "value-path": "OptionValue", "value-title": "SignProviderName", "parameters": { "Environment": { "parameter": "Environment" } } }, "description": "Choose e-Signature provider.", "x-ms-dynamic-list": { "operationId": "GetSignProvidersV4", "itemValuePath": "OptionValue", "itemTitlePath": "SignProviderName", "parameters": { "Environment": { "parameterReference": "body/Environment" } } }, "x-ms-summary": "Signing Provider" }, "Subject": { "type": "string", "description": "Default subject in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Subject" }, "Message": { "type": "string", "description": "Default message in signing request email.", "x-ms-visibility": "advanced", "x-ms-summary": "Email Default Message" }, "Signees": { "type": "array", "items": { "$ref": "#/definitions/Signee" }, "x-ms-summary": "Signee" }, "Environment": { "type": "string", "x-ms-dynamic-values": { "operationId": "GetApiKeyProfilesV4", "value-path": "EnvironmentId", "value-title": "EnvironmentName" }, "description": "Choose the environment for this operation.", "default": "(default)", "x-ms-visibility": "advanced", "x-ms-summary": "Environment" } } }, "WhoAmi": { "type": "object", "properties": { "ApiKey": { "type": "string" }, "ApiOwner": { "type": "string" }, "Environment": { "format": "int32", "type": "integer" } } }, "WhoAmiV5": { "type": "object", "properties": { "ApiKey": { "type": "string" }, "ApiOwner": { "type": "string" }, "Environment": { "format": "int32", "type": "integer" }, "ServiceAlive": { "type": "boolean" }, "ApiVersion": { "type": "string" } } } }, "securityDefinitions": { "Api_Key": { "type": "apiKey", "name": "X-Api-Key", "in": "header" } }, "security": [ { "Api_Key": [ ] } ], "x-ms-connector-metadata": [ { "propertyName": "Website", "propertyValue": "https://poweraddons.com" }, { "propertyName": "Privacy policy", "propertyValue": "https://www.mscrm-addons.com/LegalDocuments" }, { "propertyName": "Categories", "propertyValue": "Productivity;Sales and CRM" } ] }