{ "openapi": "3.0.0", "info": { "title": "The Conga MAX REST API", "description": "Welcome to the Max REST API. You can find out more about MAX at the [Conga MAX website](https://apttus.com/solutions/artificial-intelligence-quote-to-cash/). In order to explore the REST API you need a API key and a valid tenant registered with MAX.", "termsOfService": "https://apttus.com/company/legal/apttus-general-terms-of-use/", "contact": { "email": "maxcustomersupport@conga.com" }, "version": "1.0.0" }, "servers": [ { "url": "https://maxazdev.apttuscloud.io/api/v1", "description": "Max API" } ], "tags": [ { "name": "ichronos", "description": "Resolve natural language based time phrase, currency & numerical expressions" }, { "name": "isearch", "description": "Smart Search for business objects using various input flavors" }, { "name": "document", "description": "Document conversion, information, snippet extraction" }, { "name": "admin", "description": "Admin queries" } ], "paths": { "/{tenantId}/ichronos/resolvephrase": { "get": { "tags": [ "ichronos" ], "summary": "Extracts date, currency, and numbers from natural language text.", "description": "Extracts date, currency, and numbers from natural language text. This API accepts Tenant Name, Input Phrase, and Time Zone as input parameters and returns date, currency, and time as output, with options to modify the date format of the output. For example, <UL> <LI><B>Input:</B> <P><I>The Acme agreement is expected to start on the first Monday of 2021 and end two years since then and it is valued at Fifty Thousand Dollars payable within the first 3 months of next year.</I> <LI><B>Output:</B> <OL> <LI>first Monday of 2021 = 2021-01-04 <LI>two years since then = 2023-01-04 <LI>Fifty Thousand Dollars = USD 50000 <LI>the first 3 months of next year = 2021-01-01 to 2021-03-31 </OL> </UL>", "operationId": "ichronosResolvePhrase", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "input", "in": "query", "description": "Input phrase to be resolved", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "effective as of 01 / 01/ 2019" }, { "name": "timezone", "in": "query", "description": "Timezone [SID key](https://www.salesforceben.com/list-timezonesidkey-salesforce/)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "America/Los_Angeles" }, { "name": "options", "in": "query", "description": "Stringified form of JSON representing the iChronosOptions", "required": false, "schema": { "type": "string" }, "example": { "objectName": "Apttus__APTS_Agreement__c", "fullNLUResult": false, "format": "mm-dd-yyyy" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entityResponseList" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/ichronos/resolvetemplate": { "get": { "tags": [ "ichronos" ], "summary": "Extracts date and time parameters from natural language queries containing variables or templates.", "description": "Extracts date and time parameters from natural language queries containing variables or templates. This API accepts Tenant Name, Template Phrase, Time Zone, Data Map and Options as input parameters. For example, <B><I>if you provide input query as 6 weeks from contract start date and specify the contract start date as 1/1/2021 under Data Map field, it returns the output as 2/12/2021. </B></I> This API works in combination with resolvephrase API.", "operationId": "ichronosResolveTemplate", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "input", "in": "query", "description": "Input templated phrase to be resolved.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "90 days from the ${Apttus__Contract_Start_Date__c}" }, { "name": "timezone", "in": "query", "description": "Timezone [SID key](https://www.salesforceben.com/list-timezonesidkey-salesforce/)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "America/Los_Angeles" }, { "name": "dataMap", "in": "query", "description": "Stringified form of JSON representing the dataMap to resolve the template", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": { "Apttus__Contract_Start_Date__c": "2019-10-01", "Apttus__Contract_End_Date__c": "2020-10-01" } }, { "name": "options", "in": "query", "description": "Stringified form of JSON representing the iChronosOptions", "required": false, "schema": { "type": "string" }, "example": { "objectName": "Apttus__APTS_Agreement__c", "fullNLUResult": false, "format": "mm-dd-yyyy" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entityResponseList" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/ichronos/feedback": { "post": { "tags": [ "ichronos" ], "summary": "Logs app level feedback event on prior iChronos resolution", "description": "Logs app level feedback event on prior iChronos resolution. This API can be used by a client application to log analytics events that will help us understand how iChronos resolutions are performing. The API accepts Tenant Name, Prior API Response, along with the application level resolved value and the actual user specified correct value as input parameters.", "operationId": "ichronosFeedback", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "phrase", "in": "query", "description": "Input phrase that was used in recent iChronos API request.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "the term is three (3) years" }, { "name": "response", "in": "query", "description": "Stringified form of JSON response returned by iChronos", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": { "phrase": "the term is three (3) years", "entities": [ { "entity": "three (3) years", "startIndex": 12, "endIndex": 26, "type": "duration", "resolution": { "values": [ { "type": "duration", "value": 94608000000 } ] } } ] } }, { "name": "correctResolution", "in": "query", "description": "Indicates whether the iChronos resolution was accepted as is by the user. If true, user accepted as is. Else it should be set to false.", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean" }, "example": "true" }, { "name": "resolvedValue", "in": "query", "description": "Stringified JSON or just string describing how app resolved the value", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "36" }, { "name": "correctValue", "in": "query", "description": "Stringified JSON or just string describing how user corrected the value", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "48" }, { "name": "options", "in": "query", "description": "Stringified form of JSON representing the iChronosOptions. You need to pass in the context parameter with the below properties <UL> <LI>instanceUrl to identify the SFDC org originating the request. <LI>userId SFDC userId identifying the user. <LI>userName SFDC user name identifying the user. <LI>requestId indicating the x-request-id returned by the original iChronos request for which feedback is provided <LI>field such as Apttus__Contract_Start_Date__c for which the feedback is provided <LI>sessionId a unique Id identifying a set of iChronos resolutions for a single user session (eg: If start date, end date & term are resolved for a single user document, this could be set to the documentId) </UL>", "required": false, "schema": { "type": "string" }, "example": { "context": { "instanceUrl": "https://max1.my.salesforce.com", "clientVersion": "12.2020.000.0001", "userId": "0054T000000dqllQAB", "userName": "Jeremy Jones", "requestId": "29080e70-3993-437a-a923-fa59700cc07e", "field": "Apttus__Contract_Start_Date__c", "sessionId": "a0h4T000000iuqjQAA" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/tenantinfo": { "get": { "tags": [ "isearch" ], "summary": "Returns tenant profile", "description": "Returns tenant profile with limits, license types,supported modules, tables and other info.", "operationId": "isearchGetTenantInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "instanceUrl", "in": "query", "description": "Org URL", "required": true, "explode": false, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module to search Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" }, { "name": "clientVersion", "in": "query", "description": "Version of client software", "required": true, "explode": false, "schema": { "type": "string" }, "example": "12.80.000.1" }, { "name": "clientChannel", "in": "query", "description": "Channel associated with client", "required": true, "explode": false, "schema": { "type": "string" }, "example": "SFDC" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchTenantConfig" } } } } }, "security": [ { "APIKeyAuth": [] } ] }, "post": { "tags": [ "isearch" ], "summary": "Updates the tenant info object for the specific tenant", "description": "Updates thetenant info object for the specific tenant.", "operationId": "isearchPostTenantInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "instanceUrl", "in": "query", "description": "Org URL", "required": true, "explode": false, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchTenantConfig" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchTenantConfig" } } } } }, "security": [ { "APIKeyAuth": [] } ] }, "delete": { "tags": [ "isearch" ], "summary": "Deletes tenant profile", "description": "Delete the tenant profile information.", "operationId": "isearchDeleteTenantInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "instanceUrl", "in": "query", "description": "Org URL", "required": true, "explode": false, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module to delete Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/alias": { "get": { "tags": [ "isearch" ], "summary": "Returns a list of search aliases for a given user", "description": "Returns a list of search aliase associated with a user.", "operationId": "isearchGetAlias", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user or \"global\" for public alias", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchAliasInfoList" } } } } }, "security": [ { "APIKeyAuth": [] } ] }, "post": { "tags": [ "isearch" ], "summary": "Creates or updates search entire alias list for a user", "description": "Creates or updates search entire alias list for a user.", "operationId": "isearchPostAlias", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user or \"global\" for public alias", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchAliasInfoList" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchAliasInfoList" } } } } }, "security": [ { "APIKeyAuth": [] } ] }, "put": { "tags": [ "isearch" ], "summary": "Creates or updates a specific list of search aliases for a given user", "description": "Creates or updates a specific list of search aliases for a given user.", "operationId": "isearchPutAlias", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user or \"global\" for public alias", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchAliasInfoList" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] }, "delete": { "tags": [ "isearch" ], "summary": "Delete search alias(es) for a given user", "description": "Delete search alias(es) for a given user. If no aliasList is specified, entire alias list for user will be removed", "operationId": "isearchDeleteAlias", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user or \"global\" for public alias", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "aliasList", "in": "query", "description": "List of aliases to be removed", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/iSearchAliasNameList" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/displayinfo": { "get": { "tags": [ "isearch" ], "summary": "Returns a list of personalized display column setting for each search object", "description": "Returns a list of personalized display column setting for each search object.", "operationId": "isearchGetDisplayInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module to search Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchDisplayInfoList" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] }, "put": { "tags": [ "isearch" ], "summary": "Creates or updates display column info for each search object for a given user", "description": "Creates or updates display column info for each search object for a given user.", "operationId": "isearchPutDisplayInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module for display config Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchDisplayInfoList" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchDisplayInfoList" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] }, "delete": { "tags": [ "isearch" ], "summary": "Returns a list of search aliases for a given user", "description": "Returns a list of search aliase associated with a user.", "operationId": "isearchDeleteDisplayInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module for display config Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/resolveprefix": { "get": { "tags": [ "isearch" ], "summary": "Returns auto completion suggestions of prefix for type ahead", "description": "Returns auto completion suggestions of prefix for type ahead.", "operationId": "isearchResolvePrefix", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "input", "in": "query", "description": "Input prefix to be resolved", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "agreements" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/matchingPhraseList" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/resolvequeryplan": { "post": { "tags": [ "isearch" ], "summary": "Finds business objects based on query plan.", "description": "Finds business objects based on query plan. It accepts Tenant Name, Input Query, SFDC User ID of the logged-in user and Instance URL of the SFDC Org as input parameters.", "operationId": "isearchResolveQueryPlan", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "module", "in": "query", "description": "Module for display config Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" }, { "name": "timezone", "in": "query", "description": "Timezone [SID key](https://www.salesforceben.com/list-timezonesidkey-salesforce/)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "America/Los_Angeles" }, { "name": "limit", "in": "query", "description": "Record count for the query", "required": false, "schema": { "type": "integer" }, "example": 25 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchQueryResponse" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/isearch/resolvephrase": { "post": { "tags": [ "isearch" ], "summary": "Finds business objects from natural language text.", "description": "Finds business objects from natural language text. It accepts Tenant Name, Input Query, SFDC User ID of the logged-in user and Instance URL of the SFDC Org as input parameters. For example, <UL> <LI><B>Input:</B> <P><I>Pull up agreements over $20k with the mention \"Force Majeure\"</I> <LI><B>Output:</B> <P>Returns a list of agreements matching the criteria </UL>", "operationId": "isearchResolvePhrase", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "timezone", "in": "query", "description": "Timezone [SID key](https://www.salesforceben.com/list-timezonesidkey-salesforce/)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "America/Los_Angeles" }, { "name": "limit", "in": "query", "description": "Record count for the query", "required": false, "schema": { "type": "integer" }, "example": 25 }, { "name": "module", "in": "query", "description": "Module for display config Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchNLQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchResponse" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/isearch/page": { "get": { "tags": [ "isearch" ], "summary": "Returns the page specifed by pageIndex.", "description": "Returns the page specifed by pageIndex. requestId identifies the paged response", "operationId": "isearchGetPage", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "RequestId corresponding to the page", "required": true, "schema": { "type": "string" }, "example": "7fd04d80-c4c3-4ab6-a770-e9a9ff277328" }, { "name": "pageIndex", "in": "query", "description": "0 based index of the page to fetch", "required": true, "schema": { "type": "string" }, "example": 1 }, { "name": "deleteResponse", "in": "query", "description": "If true all pages associated with this request are deleted", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchResponse" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/isearch/sort": { "post": { "tags": [ "isearch" ], "summary": "Returns the records in a page in sorted order.", "description": "Returns the records in a page in sorted order. Items can be sorted either within the page or globally across all pages.Only paged responses identified by requestId can be sorted.", "operationId": "isearchPostSort", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "RequestId corresponding to the response", "required": true, "schema": { "type": "string" }, "example": "7fd04d80-c4c3-4ab6-a770-e9a9ff277328" }, { "name": "sortFields", "in": "query", "description": "List of fields for sorting. First field will be used as the primary sorting criteria. Subsequent fields will be used for secondary sorting in that order.", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "Name", "LastModifiedDate" ] }, { "name": "sortOrder", "in": "query", "description": "Sort order ASC (ascending) or DESC (descending). ASC is the default sort order", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchResponse" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/feedback": { "post": { "tags": [ "isearch" ], "summary": "Logs app level feedback event on prior iSearch resolution", "description": "Logs app level feedback event on prior iSearch resolution. This API can be used by a client application to log analytics events that will help us understand how iSearch resolutions are performing.", "operationId": "isearchFeedback", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "module", "in": "query", "description": "Module to search Eg. clm or cpq or qtc or other values", "required": true, "explode": false, "schema": { "type": "string" }, "example": "clm" }, { "name": "like", "in": "query", "description": "Like/Dislike Eg. 1 (like), -1 (dislike)", "required": true, "schema": { "type": "number" }, "example": 1 } ], "requestBody": { "description": "Original request along with options context for analytics purposes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iSearchFeedback" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/isearch/validateexpression": { "get": { "tags": [ "isearch" ], "summary": "Validates boolean expressions that constitute valid search expressions.", "description": "Validates query expressions that could be used for smart search. For example, <UL> <LI><B>Input:</B> <P><I>(1 AND 2) OR 3</I> <LI><B>Output:</B> <P>OK </UL>", "operationId": "isearchValidateExpression", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "input", "in": "query", "description": "Input phrase to be resolved", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "(1 OR 2) AND 3" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/document/snippet": { "post": { "tags": [ "document" ], "summary": "Returns the snippets matching requested keywords.", "description": "Returns the snippets matching requested keywords.", "operationId": "documentGetSnippet", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snippetExtractionInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snippetResponseWrapper" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/document/snippetfromrequest": { "post": { "tags": [ "document" ], "summary": "Returns the snippets matching requested keywords for a given search result.", "description": "Returns the snippets matching requested keywords for a given search result.", "operationId": "documentGetSnippetFromRequest", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "Request identifier identifying the search results", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "6cf63034-fe7e-4cb4-a536-549f9602219e" }, { "name": "objectId", "in": "query", "description": "Object Id associated with the text snippets to search", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "a0C4T000000iF5rUAE" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snippetExtractionInfo2" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snippetResponseForText" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/document/snippetfromfile": { "post": { "tags": [ "document" ], "summary": "Returns the snippets matching requested keywords from a file.", "description": "Returns the snippets matching requested keywords from a file.", "operationId": "documentGetSnippetFromFile", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "srcFileName": { "type": "string", "format": "string" }, "srcFormat": { "type": "string", "enum": [ "docx", "doc", "pdf", "pptx", "ppt", "csv", "xls", "xlsx", "html" ] }, "srcFile": { "type": "string", "format": "binary" }, "keywordMap": { "$ref": "#/components/schemas/keywordMap", "format": "string" }, "options": { "$ref": "#/components/schemas/snippetOptions", "format": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snippetResponseWrapper" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/document/supportedinfo": { "get": { "tags": [ "document" ], "summary": "Returns the snippets matching requested keywords.", "description": "Returns the snippets matching requested keywords.", "operationId": "documentGetSupportedInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/docSupportInfo" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/document/email": { "get": { "tags": [ "document" ], "summary": "Prepares the email content (subject, default body, attachments) etc… for a post-search share of search results for a specific object", "description": "Prepares the email content (subject, default body, attachments) etc… for a post-search share of search results", "operationId": "docGetEmailInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "Request identifier identifying the search results", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "6cf63034-fe7e-4cb4-a536-549f9602219e" }, { "name": "subject", "in": "query", "description": "Optional email subject", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Acme NDA 2020 Report" }, { "name": "body", "in": "query", "description": "Optional email body", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Below are the results of your recent search" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchResultEmail" } } } } }, "security": [ { "APIKeyAuth": [] } ] }, "post": { "tags": [ "document" ], "summary": "Send an email report of a search snapshot", "description": "Sends email report of search results", "operationId": "docPostEmailInfo", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "Request identifier", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "6cf63034-fe7e-4cb4-a536-549f9602219e" }, { "name": "to", "in": "query", "description": "To email addresses", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "fmorris@acme.com" ] }, { "name": "cc", "in": "query", "description": "Cc email addresses", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "jdaniels@acme.com" ] }, { "name": "subject", "in": "query", "description": "Optional email subject", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Acme NDA 2020 Report" }, { "name": "body", "in": "query", "description": "Optional email body", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Below are the results of your recent search" } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/document/report": { "get": { "tags": [ "document" ], "summary": "Prepares the report of search results to enable post-search sharing of results", "description": "Prepares the report of search results to enable post-search sharing of results", "operationId": "docGetReport", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "requestId", "in": "query", "description": "Request identifier", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "6cf63034-fe7e-4cb4-a536-549f9602219e" }, { "name": "format", "in": "query", "description": "Report content format Eg. html, pdf, xlsx", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "html", "pdf", "xlsx" ] }, "example": "html" }, { "name": "pageIndex", "in": "query", "description": "Optional page index. If not specified, entire result will be sent", "required": false, "style": "form", "explode": true, "schema": { "type": "string" }, "example": 1 } ], "responses": { "200": { "description": "OK" } }, "security": [ { "APIKeyAuth": [] } ] } }, "/{tenantId}/document/convert": { "post": { "tags": [ "document" ], "summary": "Convert a remote document from one format to another", "description": "Convert a remote document from one format to another.", "operationId": "documentConvert", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "userId", "in": "query", "description": "SFDC UserID of the logged in user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "0054T000000dqllQAA" }, { "name": "userName", "in": "query", "description": "Full name of the logged in SFDC user", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "Gilad Turbahn" }, { "name": "instanceUrl", "in": "query", "description": "Instance URL of the SFDC org", "required": true, "style": "form", "explode": true, "schema": { "type": "string" }, "example": "https://max1.my.salesforce.com" }, { "name": "format", "in": "query", "description": "Target format Eg. html, pdf", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "html", "pdf", "text" ] }, "example": "html" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/docInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.openxmlformats-officedocument.wordprocessing": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/html": { "schema": { "type": "string" } } } } }, "security": [ { "APIKeyAuth": [], "BearerAuth": [] } ] } }, "/{tenantId}/document/convertfile": { "post": { "tags": [ "document" ], "summary": "Convert a file document from one format to another", "description": "Convert a file document from one format to another.", "operationId": "documentConvertFile", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" }, { "name": "format", "in": "query", "description": "Target document format", "required": true, "schema": { "type": "string", "enum": [ "pdf", "html", "text" ] }, "example": "pdf" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "srcFileName": { "type": "string", "format": "string" }, "srcFormat": { "type": "string", "enum": [ "docx", "doc", "pdf", "pptx", "ppt", "csv", "xls", "xlsx", "html" ] }, "srcFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.openxmlformats-officedocument.wordprocessing": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/html": { "schema": { "type": "string" } } } } }, "security": [ { "APIKeyAuth": [] } ] } }, "/max/admin/apikey": { "get": { "tags": [ "admin" ], "summary": "Generates a unique API key that you can use to access Max APIs.", "description": "Generates a unique API key that you can use to access Max APIs. You can also activate the API Key using Max Admin Console.", "operationId": "genAPIKey", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "x-content-type": "text/plain" } } } } }, "security": [ { "APIKeyAuth": [] } ], "x-swagger-router-controller": "Admin" } }, "/{tenantId}/admin/version": { "get": { "tags": [ "admin" ], "summary": "Returns software version and config details for a tenant.", "description": "Returns software version and config details for a tenant. You can call this API to obtain the version, environment, tenant configuration, build information and other details about your Max instance.", "operationId": "adminVersion", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant name Eg. apttussfdc or max", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "apttussfdc" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/versionResponse" } } } } }, "security": [ { "APIKeyAuth": [] } ] } } }, "components": { "schemas": { "entityResponse": { "type": "object", "properties": { "entity": { "type": "string", "description": "sub phrase", "format": "string" }, "startIndex": { "type": "integer", "description": "Start index of the sub phrase", "format": "int32" }, "endIndex": { "type": "integer", "description": "End index of the sub phrase", "format": "int32" }, "type": { "type": "string", "description": "Entity resolution type", "format": "string" }, "resolution": { "$ref": "#/components/schemas/entityResolutionResultList" } } }, "entityResponseList": { "type": "object", "properties": { "phrase": { "type": "string", "description": "input phrase" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/entityResponse" } } }, "example": { "phrase": "pull up quotes expiring in the next 90 days that are starting next week", "entities": [ { "entity": "in the next 90 days", "startIndex": 24, "endIndex": 42, "type": "daterange", "resolution": { "values": [ { "type": "daterange", "start": "2020-09-11", "end": "2020-12-10" } ] } }, { "entity": "starting next week", "startIndex": 53, "endIndex": 70, "type": "daterange", "resolution": { "values": [ { "type": "daterange", "Mod": "since", "start": "2020-09-14" } ], "altValues": [ { "type": "daterange", "start": "2020-09-14", "end": "2020-09-20", "notes": "starting" } ] } } ] } }, "searchResponsePage": { "type": "object", "properties": { "index": { "type": "integer", "description": "0 based index of current result page Eg. 0" }, "total": { "type": "integer", "description": "Total number of pages in result Eg. 3" }, "pageSize": { "type": "integer", "description": "Size of each page in number of records Eg. 30" } } }, "keywordMapList": { "type": "array", "items": { "$ref": "#/components/schemas/keywordMap" } }, "keywordMap": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "List of keywords detected" }, "rawExpression": { "type": "string", "description": "The unnormalized experession constructed based on query" }, "normalizedExpression": { "type": "string", "description": "The normalized experession after factoring in the synonyms" }, "synomymMap": { "type": "object", "description": "Synonym map used for normalization" }, "missingKeywords": { "type": "boolean", "description": "If true, the keywords constitute a missing list" } }, "example": { "keywords": [ "Force majeure", "term" ], "synonymMap": { "force majeure": { "class": "Force majeure", "synonyms": [ "Force majeure", "act of god", "natural disaster", "force of nature", "natural force", "earthquake" ] }, "term": { "class": null, "synonyms": [ "term" ] } } } }, "searchResponse": { "type": "object", "properties": { "query": { "type": "string", "description": "SFDC SOQL query capturing the NL phrase", "format": "string" }, "phrase": { "type": "string", "description": "NL phrase input" }, "inputType": { "type": "string", "description": "Type of input" }, "page": { "$ref": "#/components/schemas/searchResponsePage", "description": "Paging info" }, "whereClauseFields": { "type": "array", "description": "List of fields in the where clause", "items": { "type": "string", "description": "DB field" } }, "selectFields": { "type": "array", "description": "List of select fields in the query", "items": { "type": "string", "description": "DB field" } }, "orderByFields": { "type": "array", "description": "List of fields in the order by clause", "items": { "type": "string", "description": "DB field" } }, "questionClauseFields": { "type": "array", "description": "List of fields in the question clause", "items": { "type": "string", "description": "DB field" } }, "keywordMap": { "type": "object", "description": "Keyword meta data extracted from the query", "$ref": "#/components/schemas/keywordMapList" }, "result": { "$ref": "#/components/schemas/searchResponseResult" }, "explanation": { "$ref": "#/components/schemas/explanationResult" } }, "example": { "query": "SELECT Id,Apttus_Approval__Approval_Status__c,Apttus__Agreement_Number__c,Apttus__Perpetual__c....,Apttus__LatestVersionId__r.Apttus__ContentId__c,CreatedDate,LastModifiedDate,CreatedById,CreatedBy.Name,LastModifiedById FROM Apttus__DocumentVersions__r ) FROM Apttus__APTS_Agreement__c WHERE Id IN ('a0C4T000000iGG3UAM', 'a0C4T000000iGFyUAM', ... 'a0C4T000000iBOmUAM', 'a0C4T000000iBMCUA2') AND CreatedDate >= 2020-01-01T08:00:00.000Z AND CreatedDate <= 2021-01-01T08:00:00.000Z AND (CreatedBy.Id = '0054T000000dqllQAA' OR OwnerId = '0054T000000dqllQAA') ORDER BY CreatedDate DESC NULLS LAST LIMIT 15", "phrase": "pull up agreements from last year with the mention Force Majeure or Term", "inputType": "NL", "whereClauseFields": [ "CreatedDate", "CreatedBy.Name", "Owner.Name" ], "selectFields": [], "orderByFields": [ "CreatedDate" ], "questionClauseFields": [], "keywordMap": [ { "keywords": [ "Force majeure", "term" ], "rawExpression": "(\"Force majeure\" OR \"term\")", "normalizedExpression": "((\"Force majeure\" OR \"act of god\" OR \"natural disaster\" OR \"force of nature\" OR \"natural force\" OR \"earthquake\") OR (\"term\"))", "synonymMap": { "force majeure": { "class": "Force majeure", "synonyms": [ "Force majeure", "act of god", "natural disaster", "force of nature", "natural force", "earthquake" ] }, "term": { "class": null, "synonyms": [ "term" ] } }, "missingKeywords": false } ], "result": { "object": "Apttus__APTS_Agreement__c", "objectDisplayName": "Agreement", "records": [ { "Id": "a0C4T000000iFFqUAM", "Name": "2 years issue", "Apttus__Account__r": { "Name": "Kirk Solutions" }, "Apttus__Primary_Contact__r": { "Name": "Diego Francis" }, "RecordType": { "Name": "NDA" }, "Apttus__Status_Category__c": "Import", "Apttus__Status__c": "Review", "Apttus_Approval__Approval_Status__c": "Not Submitted", "CreatedBy": { "Name": "Gilad Turbahn" }, "CreatedDate": "2020-12-31T05:43:27.000+0000", "LastModifiedBy": { "Name": "Gilad Turbahn" }, "LastModifiedDate": "2020-12-31T05:44:12.000+0000", "__docs": [ { "id": "0694T000003rc7hQAA", "type": "ContentDocument", "desc": null, "title": "Intelligent Import Sample Document -Defect two Years Ter.docx", "fileType": "WORD_X", "fileExt": "docx", "version": { "major": 1, "minor": 0, "latest": "1.0.0" }, "link": "https://max1.my.salesforce.com/sfc/servlet.shepherd/document/download/0694T000003rc7hQAA", "downloadLink": "https://max1.my.salesforce.com/services/data/v47.0/sobjects/ContentVersion/0684T000003rnzGQAQ/VersionData", "size": 17970 } ], "__link": { "value": "https://max1.my.salesforce.com/a0C4T000000iFFqUAM", "fields": [ "Name", "Id" ] } }, { "Id": "a0C4T000000iF5XUAU", "Name": "Multi value check- 2", "Apttus__Account__r": { "Name": "Kirk Solutions" }, "Apttus__Primary_Contact__r": { "Name": "Diego Francis" }, "RecordType": { "Name": "NDA" }, "Apttus__Status_Category__c": "Import", "Apttus__Status__c": "Review", "Apttus_Approval__Approval_Status__c": "Not Submitted", "CreatedBy": { "Name": "Gilad Turbahn" }, "CreatedDate": "2020-12-30T03:55:38.000+0000", "LastModifiedBy": { "Name": "Gilad Turbahn" }, "LastModifiedDate": "2020-12-30T03:56:11.000+0000", "__docs": [ { "id": "0694T000003ramnQAA", "type": "ContentDocument", "desc": null, "title": "JH-BVV_Jungheinrich Master-Agreement 26 02 2014.doc", "fileType": "WORD", "fileExt": "doc", "version": { "major": 1, "minor": 0, "latest": "1.0.0" }, "link": "https://max1.my.salesforce.com/sfc/servlet.shepherd/document/download/0694T000003ramnQAA", "downloadLink": "https://max1.my.salesforce.com/services/data/v47.0/sobjects/ContentVersion/0684T000003rmQtQAI/VersionData", "size": 52950 } ], "__link": { "value": "https://max1.my.salesforce.com/a0C4T000000iF5XUAU", "fields": [ "Name", "Id" ] } } ], "displayConfig": [ { "field": "Id", "label": "Record Id" }, { "field": "Name", "label": "Name" }, { "field": "Apttus__Account__r.Name", "label": "Account" }, { "field": "Apttus__Primary_Contact__r.Name", "label": "Primary Contact" }, { "field": "RecordType.Name", "label": "Type" }, { "field": "Apttus__Status_Category__c", "label": "Status Category" }, { "field": "Apttus__Status__c", "label": "Agreement Status" }, { "field": "Apttus_Approval__Approval_Status__c", "label": "Approval Status" }, { "field": "CreatedBy.Name", "label": "Created By" }, { "field": "CreatedDate", "label": "Created Date" }, { "field": "LastModifiedBy.Name", "label": "Last Modified By" }, { "field": "LastModifiedDate", "label": "Last Modified Date" }, { "field": "__docs", "label": "Documents" } ], "scope": { "page0": "Id IN ('a0C4T000000iFFqUAM', 'a0C4T000000iFFXUA2', 'a0C4T000000iF5rUAE', 'a0C4T000000iF5cUAE', 'a0C4T000000iF5XUAU')", "page1": "Id IN ('a0C4T000000iF5SUAU', 'a0C4T000000iDiRUAU', 'a0C4T000000iDiCUAU', 'a0C4T000000iDfAUAU', 'a0C4T000000iDf5UAE')", "page2": "Id IN ('a0C4T000000iDf0UAE', 'a0C4T000000iDHIUA2', 'a0C4T000000iCqFUAU', 'a0C4T000000iCqAUAU', 'a0C4T000000iCO5UAM')" }, "size": 15, "page": { "requestId": "c6097ddd-8050-4fa6-aacb-0f7e96e097fb", "index": 0, "total": 3, "pageSize": 5 } }, "explanation": { "mainClause": { "object": "Apttus__APTS_Agreement__c", "annotation": [ { "subphrase": "mention '\"Term\"'", "whereClause": "Id IN ('a0C4T000000iGG3UAM', 'a0C4T000000iGFyUAM', 'a0C4T000000iGFkUAM', .., 'a0C4T000000iBOmUAM', 'a0C4T000000iBOmUAM', 'a0C4T000000iBMCUA2')", "queryClauseType": "whereClause", "annotation": "50 agreements with documents matching the criteria \"Term\"", "questionClause": false }, { "subphrase": "from last year", "whereClause": "CreatedDate >= 2020-01-01T08:00:00.000Z AND CreatedDate <= 2021-01-01T08:00:00.000Z", "queryClauseType": "whereClause", "annotation": "'Created Date' is more than 2020-01-01T08:00:00.000Z AND 'Created Date' is less than 2021-01-01T08:00:00.000Z", "questionClause": false }, { "subphrase": "my (default alias)", "whereClause": "(CreatedBy.Id = '0054T000000dqllQAA' OR OwnerId = '0054T000000dqllQAA')", "queryClauseType": "alias", "annotation": "(CreatedBy.Id is 'Gilad Turbahn' OR OwnerId is 'Gilad Turbahn')", "questionClause": false }, { "subphrase": "implicit sort criteria", "whereClause": "", "queryClauseType": "sortCriteria", "annotation": "Sort by created date in DESC order", "questionClause": false }, { "subphrase": "record count", "whereClause": "", "queryClauseType": "recordCount", "annotation": "Maximum number of records fetched: 15", "questionClause": false } ] } } } }, "searchQueryResponse": { "type": "object", "properties": { "query": { "type": "string", "description": "SFDC SOQL query capturing the NL phrase", "format": "string" }, "queryPlan": { "$ref": "#/components/schemas/iSearchQuery", "description": "Input query plan" }, "page": { "$ref": "#/components/schemas/searchResponsePage", "description": "Paging info" }, "whereClauseFields": { "type": "array", "description": "List of fields in the where clause", "items": { "type": "string", "description": "DB field" } }, "selectFields": { "type": "array", "description": "List of select fields in the query", "items": { "type": "string", "description": "DB field" } }, "orderByFields": { "type": "array", "description": "List of fields in the order by clause", "items": { "type": "string", "description": "DB field" } }, "questionClauseFields": { "type": "array", "description": "List of fields in the question clause", "items": { "type": "string", "description": "DB field" } }, "keywords": { "type": "array", "description": "List of keywords detected in the query", "items": { "type": "string", "description": "keyword" } }, "result": { "$ref": "#/components/schemas/searchResponseResult" }, "explanation": { "$ref": "#/components/schemas/explanationResult" } }, "example": { "query": "SELECT Id,Apttus_Approval__Approval_Status__c...,LastModifiedDate,CreatedById,CreatedBy.Name,LastModifiedById FROM Apttus__DocumentVersions__r ) FROM Apttus__APTS_Agreement__c WHERE (CreatedDate < 2020-07-01T00:00:00.000Z AND (Apttus__Total_Contract_Value__c > 20000 OR Apttus__Perpetual__c = true)) AND Apttus__Account__c IN (SELECT Id FROM Account WHERE (BillingPostalCode = '95134' OR BillingPostalCode = '95135')) AND Id IN ('a0C4T000000gCs0UAE', 'a0C4T000000gCy2UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU') ORDER BY LastModifiedDate LIMIT 15", "queryPlan": { "primaryObject": "Apttus__APTS_Agreement__c", "clause": { "Apttus__APTS_Agreement__c": { "expression": "(1 AND (2 OR 3))", "terms": [ "CreatedDate < 2020-07-01T00:00:00.000Z", "Apttus__Total_Contract_Value__c > 20000", "Apttus__Perpetual__c = true" ] }, "Account": { "expression": "(1 OR 2)", "terms": [ "BillingPostalCode = '95134'", "BillingPostalCode = '95135'" ] } }, "scope": [ "Id IN ('a0C4T000000gCs0UAE', 'a0C4T000000gCy2UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU')" ], "alias": { "name": "PerpetualAgreementsFromPast", "private": true } }, "whereClauseFields": [ "CreatedDate", "Apttus__Total_Contract_Value__c", "Apttus__Perpetual__c", "BillingPostalCode", "Id" ], "selectFields": [], "orderByFields": [], "questionClauseFields": [], "keywordMap": [], "result": { "object": "Apttus__APTS_Agreement__c", "records": [ { "Id": "a0C4T000000gCy2UAE", "Name": "MSA", "Apttus__Account__r": { "Name": "ABC Corporation" }, "Apttus__Primary_Contact__r": { "Name": "Diego Francis" }, "RecordType": { "Name": "MSA" }, "Apttus__Status_Category__c": "In Authoring", "Apttus__Status__c": "Approved Request", "Apttus_Approval__Approval_Status__c": "Approved", "CreatedBy": { "Name": "Gilad Turbahn" }, "CreatedDate": "2019-09-12T21:40:28.000+0000", "LastModifiedBy": { "Name": "Gilad Turbahn" }, "LastModifiedDate": "2019-09-12T21:40:28.000+0000" }, { "Id": "a0C4T000000gCyEUAU", "Name": "ABC MSA", "Apttus__Account__r": { "Name": "ABC Corporation" }, "Apttus__Primary_Contact__r": { "Name": "Diego Francis" }, "RecordType": { "Name": "MSA" }, "Apttus__Status_Category__c": "In Signatures", "Apttus__Status__c": "Ready for Signatures", "Apttus_Approval__Approval_Status__c": "Approved", "CreatedBy": { "Name": "Gilad Turbahn" }, "CreatedDate": "2019-09-12T21:40:28.000+0000", "LastModifiedBy": { "Name": "Gilad Turbahn" }, "LastModifiedDate": "2020-08-05T23:29:52.000+0000" } ], "objectDisplayName": "Agreement", "displayConfig": [ { "field": "Id", "link": "https://max1.my.salesforce.com/a0C4T000000gCy2UAE", "label": "Record Id" }, { "field": "Name", "label": "Name" }, { "field": "Apttus__Account__r.Name", "label": "Account" }, { "field": "Apttus__Primary_Contact__r.Name", "label": "Primary Contact" }, { "field": "RecordType.Name", "label": "Type" }, { "field": "Apttus__Status_Category__c", "label": "Status Category" }, { "field": "Apttus__Status__c", "label": "Agreement Status" }, { "field": "Apttus_Approval__Approval_Status__c", "label": "Approval Status" }, { "field": "CreatedBy.Name", "label": "Created By" }, { "field": "CreatedDate", "label": "Created Date" }, { "field": "LastModifiedBy.Name", "label": "Last Modified By" }, { "field": "LastModifiedDate", "label": "Last Modified Date" } ], "scope": { "page0": "Id IN ('a0C4T000000gCy2UAE', 'a0C4T000000gCs0UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU')" }, "size": 6 }, "explanation": { "mainClause": { "object": "Apttus__APTS_Agreement__c", "annotation": [ { "subphrase": "Clause: Apttus__APTS_Agreement__c.CreatedDate < 2020-07-01T00:00:00.000Z", "whereClause": "CreatedDate < 2020-07-01T00:00:00.000Z", "queryClauseType": "whereClause", "annotation": "Created Date < 2020-07-01T00:00:00.000Z", "questionClause": false }, { "subphrase": "Clause: Apttus__APTS_Agreement__c.Apttus__Total_Contract_Value__c > 20000", "whereClause": "Apttus__Total_Contract_Value__c > 20000", "queryClauseType": "whereClause", "annotation": "Total Agreement Value > 20000", "questionClause": false }, { "subphrase": "Clause: Apttus__APTS_Agreement__c.Apttus__Perpetual__c = true", "whereClause": "Apttus__Perpetual__c = true", "queryClauseType": "whereClause", "annotation": "Perpetual = true", "questionClause": false }, { "subphrase": "Nested Clause: Account.BillingPostalCode = '95134'", "whereClause": "BillingPostalCode = '95134'", "queryClauseType": "whereClause", "annotation": "Billing Zip/Postal Code = '95134'", "questionClause": false }, { "subphrase": "Nested Clause: Account.BillingPostalCode = '95135'", "whereClause": "BillingPostalCode = '95135'", "queryClauseType": "whereClause", "annotation": "Billing Zip/Postal Code = '95135'", "questionClause": false }, { "subphrase": "Scope: Apttus__APTS_Agreement__c.Id IN ('a0C4T000000gCs0UAE', 'a0C4T000000gCy2UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU')", "whereClause": "Id IN ('a0C4T000000gCs0UAE', 'a0C4T000000gCy2UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU')", "queryClauseType": "whereClause", "annotation": "Record ID IN ('a0C4T000000gCs0UAE', 'a0C4T000000gCy2UAE', 'a0C4T000000gCxlUAE', 'a0C4T000000gCyBUAU', 'a0C4T000000gCxjUAE', 'a0C4T000000gCyEUAU')", "questionClause": false } ] } } } }, "iChronosOptions": { "type": "object", "properties": { "fullNLUResult": { "type": "boolean", "description": "If true, returns the full result (NLU + iChronos results). Otherwise only iChronos results are returned", "format": "boolean", "default": false }, "objectName": { "type": "string", "description": "Table name of the object. This is used to generate template expressions for relative time phrases", "example": "Apttus__APTS_Agreement__c" }, "resolveRelativeReference": { "type": "boolean", "description": "Indicates whether to resolve relative reference expressions to templates", "format": "boolean", "default": true }, "context": { "type": "object", "description": "Any JSON object that will be logged in analytics payload associated with this request. SFDC instanceUrl will be a helpful context setting to pass in." }, "format": { "type": "string", "description": "Date format such as mm/dd/yyyy (where m=month, d=day, y=year)", "default": "yyyy-mm-dd" }, "startOfQuarter": { "type": "string", "default": "01-01-current", "description": "There are a few variations of this <OL> <LI>Current Fiscal Year starts and ends on calendar schedule => No config needed <LI>Current Fiscal Year begins previous calendar year and runs into current year and ends during the calendar year and the next fiscal begins during the calendar year. This is typical. In this case configure the StartOfQuarter as below. An example: <UL> <LI>Current calendar year = 2019, Fiscal Year = 2019 <LI>FY 2019 began 06/15/2018 and ends 06/14/2019 <LI>Q1: 06/15/2018 to 09/14/2018 <LI>Q2: 09/15/2018 to 12/14/2018 <LI>Q3: 12/15/2018 to 03/14/2019 <LI>Q4: 03/15/2019 to 06/14/2019 <LI>startOfQuarter = \"06-15-next\" ← We are telling MAX that the next fiscal year begins on 06/15 during calendar year 2019. With this hint, MAX will automatically compute the current and next fiscal years </UL> <LI>Current Fiscal Year begins in the middle of the calendar year and runs into next year and ends during the next calendar year while the prior fiscal ends during the current calendar year. This is somewhat unsual but possible. In this case configure the StartOfQuarter as below. An example: <UL> <LI>Current calendar year = 2019, Fiscal Year = 2019 <LI>FY 2019 began 06/15/2019 and ends 06/14/2020 <LI>Q1: 06/15/2019 to 09/14/2019 <LI>Q2: 09/15/2019 to 12/14/2019 <LI>Q3: 12/15/2019 to 03/14/2020 <LI>Q4: 03/15/2020 to 06/14/2020 <LI>startOfQuarter = \"06-15-current\" ← We are telling MAX that the current fiscal year begins on 06/15 during the calendar year 2019. With this hint, MAX will automatically compute the current and next fiscal years </UL> <LI>Prior Fiscal Year begins in the middle of the calendar year and runs into next year and ends during the next calendar year. This is very rare and unsual but theoreticallypossible. In this case configure the StartOfQuarter as below. An example: <UL> <LI>Current calendar year = 2019, Fiscal Year = 2018 <LI>FY 2018 began 06/15/2019 and ends 06/14/2020 <LI>Q1: 06/15/2019 to 09/14/2019 <LI>Q2: 09/15/2019 to 12/14/2019 <LI>Q3: 12/15/2019 to 03/14/2020 <LI>Q4: 03/15/2020 to 06/14/2020 <LI>startOfQuarter = \"06-15-prior\" ← We are telling MAX that the prior fiscal year begins on 06/15 during the calendar year 2019. With this hint, MAX will automatically compute the current and next fiscal years </UL> </OL>", "example": "a) 03-15-current (FY20 begins 03-15-2020 and ends 03-14-2021) b) 03-15-next (FY 21 begins on 03-15-2020 and ends 03-14-2021) or c) 01-15-prior (FY 19 begins 03-15-2020 and ends 03-14-2021)" }, "startOfWeek": { "type": "string", "default": "monday", "description": "Weekday that marks the beginning of the week.", "example": "sunday or saturday (any day of the week)" } }, "example": { "objectName": "Apttus__APTS_Agreement__c", "fullNLUResult": false, "format": "mm-dd-yyyy" } }, "dataMap": { "type": "object", "additionalProperties": { "type": "string", "description": "Map of key-value pairs that contains values for keys to be substituted in the templated expression" }, "example": { "Apttus__Contract_Start_Date__c": "2019-10-01", "Apttus__Contract_End_Date__c": "2020-10-01" } }, "searchOptions": { "type": "object", "properties": { "fetchResults": { "type": "boolean", "description": "If true, resolve query and return object Ids matching the query", "format": "boolean", "default": false }, "fetchQueryPlan": { "type": "boolean", "description": "If true, return query plan used to resolve the NL phrase", "format": "boolean", "default": false }, "mask": { "type": "boolean", "description": "If true, redact input phrase details in analytics logging", "format": "boolean", "default": false }, "sessionTreatment": { "type": "string", "description": "'clear' => Clears the session, 'keep-alive' => Does not alter the session, 'terminate' (or any other value) => Terminates the session", "format": "string", "default": "terminate" }, "applyDefaultAlias": { "type": "boolean", "description": "If true, for applicable objects, a default implicit alias will be applied. Eg, When querying for opportunities only opportunities with stage open will be returned", "default": true }, "personalize": { "type": "boolean", "description": "If true, only the searching user created or owned records will be used for search", "default": true }, "searchLimit": { "type": "integer", "description": "Max # records to pull up while doing document search", "default": 300 }, "pageSize": { "type": "integer", "description": "Max # records to return in a single response", "default": 30 }, "timeout": { "type": "integer", "description": "Timeout in millisecs allowed for the execution of a search query. Max timeout permissible is 90 secs", "default": 15000 }, "context": { "type": "object", "description": "Any JSON object that will be logged in analytics payload" } }, "example": { "fetchResults": true, "sessionTreatment": "clear", "enableSynonymSearch": true } }, "searchResponseResult": { "type": "object", "properties": { "object": { "type": "string", "description": "Object returned in results" }, "objectDisplayName": { "type": "string", "description": "Object display name" }, "records": { "type": "array", "description": "Object record data", "items": { "$ref": "#/components/schemas/recordData" } }, "size": { "type": "integer", "description": "Number of results" }, "questionClauseMatchSize": { "type": "integer", "description": "Number of question clause matches (if question clause is present)" }, "docs": { "$ref": "#/components/schemas/docResultList" } }, "example": { "size": 0, "records": {}, "object": "object" } }, "docResultList": { "type": "array", "items": { "$ref": "#/components/schemas/docResult" } }, "docResult": { "type": "object", "properties": { "id": { "type": "string", "description": "Document ID" }, "type": { "type": "string", "description": "Document Type in SFDC Eg. ContentDocument" }, "desc": { "type": "string", "description": "Document description" }, "title": { "type": "string", "description": "Document title" }, "fileType": { "type": "string", "description": "Document file type Eg. WORD_X" }, "fileExt": { "type": "string", "description": "Document file extension Eg. docx" }, "version": { "description": "Document major, minor & latest version", "$ref": "#/components/schemas/docVersion" }, "link": { "type": "string", "description": "SFDC link to the document page" }, "downloadLink": { "type": "string", "description": "SFDC download link for the raw document" }, "size": { "type": "integer", "description": "Document size in bytes" } }, "example": { "id": "0694T000003rIf5QAE", "type": "ContentDocument", "desc": null, "title": "Final_Term_Defect check for apostrophy.docx", "fileType": "WORD_X", "fileExt": "docx", "version": { "major": 1, "minor": 0, "latest": "1.0.0" }, "link": "https://max1.my.salesforce.com/sfc/servlet.shepherd/document/download/0694T000003rIf5QAE", "downloadLink": "https://max1.my.salesforce.com/services/data/v47.0/sobjects/ContentVersion/0684T000003rTKaQAM/VersionData", "size": 20608 } }, "docVersion": { "type": "object", "description": "Document version", "properties": { "major": { "type": "string", "description": "Major version of doc" }, "minor": { "type": "string", "description": "Minor version of doc" }, "latest": { "type": "string", "description": "Latest version of doc." } } }, "recordData": { "type": "object", "description": "Entity resolution", "properties": { "Id": { "type": "string", "description": "Object ID" }, "field": { "type": "string", "description": "Field name and value in the record" }, "match": { "type": "boolean", "description": "If true, this record matches question clause." } } }, "entityResolutionResultList": { "type": "object", "description": "Entity resolution", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/entityResolutionResult" } } } }, "entityResolutionResult": { "type": "object", "description": "Explanation of query clause", "properties": { "type": { "type": "string", "description": "Entity type" }, "Mod": { "type": "string", "description": "Modifier" }, "start": { "type": "string", "description": "Start date of time period", "format": "datetime" }, "end": { "type": "string", "description": "End date of time period", "format": "datetime" } } }, "explanationResult": { "type": "object", "description": "Explanation of query", "properties": { "mainClause": { "type": "object", "description": "Main object clause list", "properties": { "object": { "type": "string", "description": "Object returned in results" }, "annotation": { "type": "array", "description": "Annotation of clauses", "items": { "$ref": "#/components/schemas/annotationItem" } } } }, "nestedClause": { "type": "object", "description": "Nested object clause list", "properties": { "object": { "type": "string", "description": "Object returned in results" }, "annotation": { "type": "array", "description": "Annotation of clauses", "items": { "$ref": "#/components/schemas/annotationItem" } } } } } }, "annotationItem": { "type": "object", "description": "Explanation of query clause", "properties": { "subphrase": { "type": "object", "description": "User NL subphrase" }, "whereClause": { "type": "object", "description": "Actual where clause" }, "annotation": { "type": "object", "description": "Annotation of where clause" }, "questionClause": { "type": "boolean", "description": "Is this a question clause?" } } }, "versionResponse": { "type": "object", "description": "Max platform and tenant version info", "properties": { "version": { "type": "string", "description": "Max platform version" }, "buildTime": { "type": "string", "description": "Time the version was built" }, "platformSubroutines": { "type": "string", "description": "Last update time for platform subroutines" }, "platformDialogs": { "type": "string", "description": "Last update time for platform dialogs" }, "platformConversations": { "type": "string", "description": "Last update time for platform conversations" }, "tenantSubroutines": { "type": "string", "description": "Last update time for tenant subroutines" }, "tenantDialogs": { "type": "string", "description": "Last update time for tenant dialogs" }, "tenantConversations": { "type": "string", "description": "Last update time for tenant conversations" }, "tenantConfig": { "type": "string", "description": "Last update time for tenant configuration" } }, "example": { "version": "4.0.0.472", "buildTime": "2020-10-15T02:14:45.000Z (2 hours ago)", "currentTimeUTC": "2020-10-15T05:11:39.527Z (now)", "startTime": "2020-10-15T03:21:12.910Z (1 hours ago)", "platformConversations": "2020-10-15T03:21:23.664Z (1 hours ago)", "platformDialogs": "2020-10-15T03:19:56.994Z (1 hours ago)", "platformSubroutines": "2020-10-15T03:20:42.958Z (1 hours ago)", "tenant": "ApttusSFDC", "tenantDialogs": "2020-10-15T03:21:13.598Z (1 hours ago)", "tenantConversations": "2020-10-15T03:21:13.598Z (1 hours ago)", "tenantSubroutines": "2020-10-15T03:21:37.994Z (1 hours ago)", "tenantConfig": "2020-10-15T03:21:05.678Z (1 hours ago)", "env": "Azure_qa" } }, "iSearchTenantConfig": { "type": "object", "format": "string", "description": "Max platform and tenant version info", "properties": { "clientVersion": { "type": "string", "description": "Client version" }, "clientChannel": { "type": "string", "description": "Client channel such as sfdc, slack, teams" }, "license": { "type": "string", "description": "License type" }, "emailReportTemplate": { "type": "object", "description": "Search limits", "properties": { "subject": { "type": "string", "description": "Email template subject" }, "body": { "type": "string", "description": "Email template body" } } }, "limits": { "type": "object", "description": "Search limits" }, "defaultTenant": { "type": "boolean", "description": "Is this a standard default tenant or custom Max tenant" }, "module": { "type": "string", "description": "Module subscribed to for search" }, "searchObjects": { "type": "object", "description": "Objects available for search" } }, "example": { "clientVersion": "12.80.000.1", "clientChannel": "SFDC", "license": "full", "defaultTenant": false, "module": "clm", "searchObjects": [ { "object": "Opportunity", "objectId": "opportunity", "related": [ "Account", "Contact", "Apttus__APTS_Agreement__c", "Apttus__Agreement_Clause__c", "Apttus_Approval__Approval_Request__c" ] }, { "object": "Account", "objectId": "account", "related": [ "Opportunity", "Contact", "Apttus__APTS_Agreement__c", "Apttus__Agreement_Clause__c", "Apttus_Approval__Approval_Request__c" ] }, { "object": "Contact", "objectId": "contact", "related": [ "Opportunity", "Account", "Apttus__APTS_Agreement__c", "Apttus__Agreement_Clause__c", "Apttus_Approval__Approval_Request__c" ] }, { "object": "Apttus__APTS_Agreement__c", "objectId": "agreement", "primary": true, "related": [ "Opportunity", "Account", "Contact", "Apttus__Agreement_Clause__c", "Apttus_Approval__Approval_Request__c" ], "enableDocSearch": true }, { "object": "Apttus__Agreement_Clause__c", "objectId": "agreementclause", "related": [ "Opportunity", "Account", "Contact", "Apttus__APTS_Agreement__c", "Apttus_Approval__Approval_Request__c" ], "enableDocSearch": true }, { "object": "Apttus_Approval__Approval_Request__c", "objectId": "approval", "related": [ "Opportunity", "Account", "Contact", "Apttus__APTS_Agreement__c", "Apttus__Agreement_Clause__c" ] }, { "object": "Apttus__ReviewCycle__c", "objectId": "reviewcycle", "related": [ "Account", "Contact", "Apttus__APTS_Agreement__c" ] }, { "object": "Apttus__Reviewer__c", "objectId": "reviewer", "related": [ "Account", "Contact", "Apttus__APTS_Agreement__c" ] } ], "emailReportTemplate": { "subject": "${objectname} report ${date}", "body": "Hi -- Here is the report of the recent search you ran\n. Thanks\n!" }, "limits": { "alias": 15, "snippetWindowSize": 200, "maxSnippetsInSearch": 10, "snippetMatchIgnoreCase": true, "startSnippetMatchAtPage": 0, "endSnippetMatchAtPage": -1, "enableSynonymSearch": false, "matchWholeWordsOnly": true, "docSearchLimit": 300, "searchResultLimit": 100, "pageSize": 30, "enableLargeFileSearch": true }, "tenantId": "apttussfdc", "userId": "user", "channel": "api", "org": "https://max1.my.salesforce.com", "lastUpdateTime": 1610503940289 } }, "iSearchAliasInfoList": { "type": "array", "format": "string", "items": { "$ref": "#/components/schemas/iSearchAliasInfo" }, "example": { "NDA2020": { "type": "NL", "query": { "expression": "Pull up NDAs from 2020" }, "desc": "NDAs from the year 2020", "private": false }, "IBM-NDA2020": { "type": "NL", "query": { "scope": [ "Apttus__Account__r.Name = 'IBM'" ], "expression": "Pull up NDAs from 2020" }, "desc": "NDAs from the year 2020", "private": true }, "HighValuePastAgreements": { "type": "QueryPlan", "desc": "High value agreements prior to this year", "private": false, "primaryObject": "Apttus__APTS_Agreement__c", "query": { "clause": { "Apttus__APTS_Agreement__c": { "expression": "(1 AND (2 OR 3))", "terms": [ "CreatedDate < 2020-07-01T00:00:00.000Z", "Apttus__Total_Contract_Value__c > 20000", "Apttus__Perpetual__c = true" ] }, "Account": { "expression": "(1 OR 2)", "terms": [ "BillingPostalCode = '95134'", "BillingPostalCode = '95135'" ] } } } } } }, "iSearchAliasInfo": { "type": "object", "description": "Search alias config", "properties": { "name": { "type": "string", "description": "Name of the alias" }, "type": { "type": "string", "description": "Alias type (NL, QueryPlan)" }, "desc": { "type": "string", "description": "Description of the alias" }, "query": { "$ref": "#/components/schemas/iSearchQuery", "description": "Query expression" } }, "example": { "name": "NDA2020", "type": "NL", "query": { "expression": "Pull up NDAs from 2020" }, "desc": "NDAs from the year 2020" } }, "iSearchFeedback": { "type": "object", "description": "iSearch query block", "properties": { "scope": { "type": "array", "description": "List of conditions specifying the candidate objects on which the query plan must be executed", "items": { "$ref": "#/components/schemas/iSearchQueryTerm" } }, "input": { "oneOf": [ { "$ref": "#/components/schemas/iSearchNLQuery" }, { "$ref": "#/components/schemas/iSearchQuery" } ], "description": "Search input (stringified JSON of iSearchNLQuery or iSearchQueryPlan)" }, "query": { "type": "object", "description": "Optional query plan object" }, "options": { "description": "Stringified form of JSON representing the iChronosOptions. You need to pass in the context parameter with the below properties <UL> <LI>instanceUrl to identify the SFDC org originating the request. <LI>userId SFDC userId identifying the user. <LI>userName SFDC user name identifying the user. <LI>requestId indicating the x-request-id returned by the original iChronos request for which feedback is provided", "type": "object" } }, "example": { "input": { "scope": [ "Id IN ('a0C4T000000gCrZUAU', 'a0C4T000000gCraUAE')" ], "phrase": "pull up agreements from last year with the mention \"Term\"", "options": { "fetchResults": true, "sessionTreatment": "clear", "pageSize": 4 }, "alias": { "name": "Recent agreement terms", "private": true } }, "result": { "recordCount": 15, "docCount": 5, "pageTotal": 4, "pageSize": 4, "keywords": [ "Force Majeure", "Terms" ] }, "context": { "instanceUrl": "https://max1.my.salesforce.com", "userId": "0054T000000dqllQAB", "userName": "Jeremy Jones", "requestId": "29080e70-3993-437a-a923-fa59700cc07e" } } }, "iSearchNLQuery": { "type": "object", "description": "iSearch query block", "properties": { "scope": { "type": "array", "description": "List of conditions specifying the candidate objects on which the query plan must be executed", "items": { "$ref": "#/components/schemas/iSearchQueryTerm" } }, "phrase": { "type": "string", "description": "NL phrase" }, "options": { "$ref": "#/components/schemas/searchOptions" } }, "example": { "scope": [ "RecordType.Name IN ('NDA')" ], "phrase": "pull up agreements from last year with the mention \"Term\"", "options": { "fetchResults": true, "sessionTreatment": "clear", "pageSize": 4, "enableSynonymSearch": false }, "alias": { "name": "Recent agreement terms", "private": true } } }, "iSearchQuery": { "type": "object", "description": "iSearch query block", "properties": { "primaryObject": { "type": "string", "description": "Primary object being queried" }, "scope": { "type": "array", "description": "List of conditions specifying the candidate objects on which the query plan must be executed", "items": { "$ref": "#/components/schemas/iSearchQueryTerm" } }, "clause": { "type": "array", "items": { "$ref": "#/components/schemas/iSearchQueryClauseList" } }, "options": { "$ref": "#/components/schemas/searchOptions" } }, "example": { "primaryObject": "Apttus__APTS_Agreement__c", "scope": [ "Id IN ('a0C4T000000gCrZUAU', 'a0C4T000000gCraUAE')" ], "clause": { "Apttus__APTS_Agreement__c": { "expression": "(1 AND (2 OR 3))", "terms": [ "CreatedDate < 2020-07-01T00:00:00.000Z", "Apttus__Total_Contract_Value__c > 20000", "Apttus__Perpetual__c = true" ], "keywords": "Force Majeure and Term but not Tax Credits" }, "Account": { "expression": "(1 OR 2)", "terms": [ "BillingPostalCode = '95134'", "BillingPostalCode = '95135'" ] } }, "options": { "fetchResults": true, "sessionTreatment": "clear" }, "alias": { "name": "PerpetualAgreementsFromPast", "private": true } } }, "iSearchQueryClauseList": { "type": "array", "items": { "$ref": "#/components/schemas/iSearchQueryClause" } }, "iSearchQueryClause": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/iSearchQueryClauseItem" } }, "iSearchQueryClauseItem": { "type": "object", "properties": { "expression": { "type": "string", "description": "Query expression" }, "terms": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "string", "description": "Keyword expression" } } }, "iSearchQueryTerm": { "type": "object", "additionalProperties": { "type": "string", "description": "Map of key-value pairs that contains table to query term mapping" } }, "iSearchDisplayInfoList": { "type": "object", "format": "string", "description": "Display config for search results", "properties": { "object": { "$ref": "#/components/schemas/iSearchDisplayInfo" } }, "example": { "searchObjects": { "Opportunity": [ { "label": "Opportunity Name", "type": "string", "field": "Name" }, { "label": "Account", "type": "string", "field": "Account.Name" }, { "label": "Owner", "type": "string", "field": "Owner.Name" }, { "label": "Stage Name", "type": "picklist", "field": "StageName" }, { "label": "Amount", "type": "currency", "field": "Amount" }, { "label": "Close Date", "type": "date", "field": "CloseDate" } ], "Account": [ { "label": "Account Name", "type": "string", "field": "Name" }, { "label": "Primary Contact", "type": "string", "field": "APTSMD_Primary_Contact__r.Name" }, { "label": "Type", "type": "picklist", "field": "Type" }, { "label": "Account Owner", "type": "string", "field": "Owner.Name" }, { "label": "Industry", "type": "picklist", "field": "Industry" }, { "label": "Billing Address", "type": "textarea", "field": "BillingStreet" } ], "Contact": [ { "label": "Contact Name", "type": "string", "field": "Name" }, { "label": "Account Name", "type": "string", "field": "Account.Name" }, { "label": "Title", "type": "string", "field": "Title" }, { "label": "Contact Owner", "type": "string", "field": "Owner.Name" }, { "label": "Phone Number", "type": "phone", "field": "Phone" }, { "label": "Email", "type": "email", "field": "Email" }, { "label": "Mailing Address", "type": "textarea", "field": "MailingStreet" } ], "Apttus__APTS_Agreement__c": [ { "label": "Name", "type": "string", "field": "Name" }, { "label": "Account", "type": "string", "field": "Apttus__Account__r.Name" }, { "label": "Primary Contact", "type": "string", "field": "Apttus__Primary_Contact__r.Name" }, { "label": "Type", "type": "string", "field": "RecordType.Name" }, { "label": "Status Category", "type": "picklist", "field": "Apttus__Status_Category__c" }, { "label": "Agreement Status", "type": "picklist", "field": "Apttus__Status__c" }, { "label": "Approval Status", "type": "picklist", "field": "Apttus_Approval__Approval_Status__c" }, { "label": "Created By", "type": "string", "field": "CreatedBy.Name" }, { "label": "Created Date", "type": "datetime", "field": "CreatedDate" }, { "label": "Last Modified By", "type": "string", "field": "LastModifiedBy.Name" }, { "label": "Last Modified Date", "type": "datetime", "field": "LastModifiedDate" } ], "Apttus__Agreement_Clause__c": [ { "label": "Account", "type": "string", "field": "Apttus__Agreement__r.Apttus__Account__r.Name" }, { "label": "Agreement", "type": "string", "field": "Apttus__Agreement__r.Name" }, { "label": "Primary Contact", "type": "string", "field": "Apttus__Agreement__r.Apttus__Primary_Contact__r.Name" }, { "label": "Category", "type": "picklist", "field": "Apttus__Category__c" }, { "label": "Approval Status", "type": "picklist", "field": "Approval_Status__c" }, { "label": "Created By", "type": "string", "field": "CreatedBy.Name" }, { "label": "Created Date", "type": "datetime", "field": "CreatedDate" }, { "label": "Last Modified By", "type": "string", "field": "LastModifiedBy.Name" }, { "label": "Last Modified Date", "type": "datetime", "field": "LastModifiedDate" } ], "Apttus_Approval__Approval_Request__c": [ { "label": "Business Object", "type": "string", "field": "Apttus_Approval__Object_Name__c" }, { "label": "Approval Request Id", "type": "string", "field": "Name" }, { "label": "Approval Request Status", "type": "picklist", "field": "Apttus_Approval__Approval_Status__c" }, { "label": "Assigned To", "type": "string", "field": "Apttus_Approval__Assigned_To_Name__c" }, { "label": "Approval Details", "type": "textarea", "field": "Apttus_Approval__Request_Comments__c" }, { "label": "Initial Submitter", "type": "string", "field": "Apttus_Approval__Initial_Submitter__r.Name" }, { "label": "Approver Comments", "type": "textarea", "field": "Apttus_Approval__Approver_Comments__c" }, { "label": "Requestor Comments", "type": "textarea", "field": "Apttus_Approval__SubmissionComment1__c" } ], "Apttus__ReviewCycle__c": [ { "label": "Name", "type": "string", "field": "Name" }, { "label": "Agreement", "type": "string", "field": "Apttus__OriginalDocumentVersionDetail__r.Apttus__DocumentVersionId__r.Apttus__AgreementId__r.Name" }, { "label": "Account", "type": "string", "field": "Apttus__OriginalDocumentVersionDetail__r.Apttus__DocumentVersionId__r.Apttus__AgreementId__r.Apttus__Account__r.Name" }, { "label": "Review Status", "type": "picklist", "field": "Apttus__ReviewStatus__c" }, { "label": "Created Date", "type": "datetime", "field": "CreatedDate" }, { "label": "Created By", "type": "string", "field": "CreatedBy.Name" } ], "Apttus__Reviewer__c": [ { "label": "Review Cycle", "type": "string", "field": "Apttus__ReviewCycle__r.Name" }, { "label": "Agreement", "type": "string", "field": "Apttus__ReviewCycle__r.Apttus__OriginalDocumentVersionDetail__r.Apttus__DocumentVersionId__r.Apttus__AgreementId__r.Name" }, { "label": "Account", "type": "string", "field": "Apttus__ReviewCycle__r.Apttus__OriginalDocumentVersionDetail__r.Apttus__DocumentVersionId__r.Apttus__AgreementId__r.Apttus__Account__r.Name" }, { "label": "Name", "type": "string", "field": "Name" }, { "label": "Email", "type": "email", "field": "Apttus__ReviewerEmail__c" }, { "label": "Review Status", "type": "picklist", "field": "Apttus__ReviewStatus__c" }, { "label": "Created Date", "type": "datetime", "field": "CreatedDate" }, { "label": "Created By", "type": "string", "field": "CreatedBy.Name" } ] }, "tenantId": "apttussfdc", "userId": "0054T000000dqllQAA", "channel": "api", "org": "https://max1.my.salesforce.com", "module": "clm", "lastUpdateTime": 1610089483217 } }, "iSearchDisplayInfo": { "type": "array", "items": { "$ref": "#/components/schemas/iSearchDisplayColumn" } }, "iSearchDisplayColumn": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label" }, "type": { "type": "string", "description": "Column type" }, "field": { "type": "string", "description": "Display column field" } } }, "iSearchAliasNameList": { "type": "array", "items": { "type": "string" }, "example": [ "NDA2020", "HighValueMSAs" ] }, "keywordList": { "type": "array", "items": { "type": "string" }, "example": [ "Force Majeure", "Tax Credits" ] }, "snippetExtractionInfo": { "type": "object", "properties": { "doc": { "$ref": "#/components/schemas/docInfo" }, "options": { "$ref": "#/components/schemas/snippetOptions" }, "keywordMap": { "$ref": "#/components/schemas/keywordMap" } } }, "snippetExtractionInfo2": { "type": "object", "properties": { "options": { "$ref": "#/components/schemas/snippetOptions" }, "keywordMap": { "$ref": "#/components/schemas/keywordMap" } } }, "docInfo": { "type": "object", "format": "string", "description": "Document meta data", "properties": { "id": { "type": "string", "description": "Identifier", "example": "0684T000003rao4QAA" }, "url": { "type": "string", "description": "Full URL or relative path to the document download URL", "example": "/services/data/v47.0/sobjects/ContentVersion/0684T000003rao4QAA/VersionData" }, "type": { "type": "string", "description": "SFDC object type" }, "title": { "type": "string", "description": "Doc title" }, "format": { "type": "string", "description": "Doc format Eg. doc, docx, pdf, rtf" }, "size": { "type": "number", "description": "Document size" } }, "example": { "id": "0684T000003rao4QAA", "url": "/services/data/v47.0/sobjects/ContentVersion/0684T000003rao4QAA/VersionData", "title": "TC_2349-KIRA Extraction- Term (In Years).docx", "type": "ContentDocument", "format": "docx", "size": 2397 } }, "snippetResponseForText": { "type": "object", "description": "Snippet response wrapper", "properties": { "object": { "type": "string", "description": "Object Id corresponding to the text", "example": "0684T000003rao4QAA" }, "type": { "type": "string", "description": "Text blob type", "example": "textBlob" }, "snippets": { "$ref": "#/components/schemas/snippetResponseList" } }, "example": { "object": "a0L4T000000ToMAUA0", "type": "textBlob", "snippets": [ { "snippet": "olding agent shall provide reasonable cooperation to the Company in claiming any corresponding U.S. tax credits, including without limitation by providing to Company the withholding tax certificate is", "keywords": [ { "class": "Tax credits", "searchWord": "Tax credits", "synonymMatch": "Tax credits", "startIndex": 100, "endIndex": 110 } ], "page": 1, "snippetStartIndex": 250, "snippetEndIndex": 450, "size": 200, "label": "Text" } ] } }, "snippetResponseWrapper": { "type": "object", "description": "Snippet response wrapper", "properties": { "url": { "type": "string", "description": "Full URL or relative path to the document download URL", "example": "/services/data/v47.0/sobjects/ContentVersion/0684T000003rao4QAA/VersionData" }, "type": { "type": "string", "description": "File format type Eg. pdf, docx", "example": "pdf" }, "name": { "type": "string", "description": "Document name", "example": "Intelligent-Import-Demo.pdf" }, "snippets": { "$ref": "#/components/schemas/snippetResponseList" } } }, "snippetResponseList": { "type": "array", "description": "List of snippets", "items": { "$ref": "#/components/schemas/snippetResponse" }, "example": { "url": "https://max1.my.salesforce.com/services/data/v47.0/sobjects/ContentVersion/0684T000003rao4QAA/VersionData", "name": "TC_2349-KIRA Extraction- Term (In Years).docx", "type": "docx", "snippets": [ { "snippet": " Service giving rise to such claim, or (b) USD $1,000,000 (One Million United States Dollars). The Term of this Agreement shall be for an initial period of three (3) years after the Effective Date o", "keywords": [ { "class": "term", "searchWord": "term", "synonymMatch": "term", "startIndex": 100, "endIndex": 104 } ], "page": 2, "snippetStartIndex": 1669, "snippetEndIndex": 1869, "size": 200 }, { "snippet": "ll have given notice of termination of this Agreement sixty (60) days before the end of the initial term or any renewal term, or unless otherwise terminated in accordance with this Agreement. Terminat", "keywords": [ { "class": "term", "searchWord": "term", "synonymMatch": "term", "startIndex": 100, "endIndex": 104 } ], "page": 2, "snippetStartIndex": 1986, "snippetEndIndex": 2186, "size": 200 }, { "snippet": "eement relates, whether by merger, sale of assets, sale of stock, reorganization or otherwise. Force Majeure. Neither party shall be liable to the other party for its failure to perform any of ", "keywords": [ { "class": "Force majeure", "searchWord": "Force of Nature", "synonymMatch": "Force majeure", "startIndex": 100, "endIndex": 113 }, { "class": "liable", "searchWord": "liable", "synonymMatch": "liable", "startIndex": 140, "endIndex": 146 } ], "page": 2, "snippetStartIndex": 3534, "snippetEndIndex": 3734, "size": 200 } ] } }, "snippetResponse": { "type": "object", "description": "Single snippet", "properties": { "snippet": { "type": "string", "description": "Text snippet" }, "page": { "type": "number", "description": "Page number" }, "keywords": { "type": "array", "items": { "type": "string" } } }, "example": { "snippet": "The Force of Nature clause: .....", "keywords": [ { "class": "Force Majeure", "searchWord": "Act of God", "synonymMatch": "Force of Nature" } ], "page": 2, "startIndex": 21, "endIndex": 221, "size": 201 } }, "snippetOptions": { "type": "object", "description": "Snippet extraction options", "properties": { "snippetWindowSize": { "type": "integer", "description": "snippet size extracted (min = 200)", "default": 200 }, "maxSnippets": { "type": "integer", "description": "Max no. of snippets to be extracted from a document", "default": 30 }, "matchWholeWordsOnly": { "type": "boolean", "description": "If true only whole words will be matched.", "default": true }, "snippetMatchIgnoreCase": { "type": "boolean", "description": "Ignore case for snippet match", "default": true }, "enableSynonymSearch": { "type": "boolean", "description": "If true synonyms of keywords are searched.", "default": false }, "startSnippetMatchAtPage": { "type": "integer", "description": "The page number to start match from. 0 - based index. Use -1 to start from last page, -2 from second last etc..", "default": 0 }, "endSnippetMatchAtPage": { "type": "integer", "description": "The page number to end match. 0 - based index. Use -1 to end at last page, -2 at second last etc..", "default": -1 } }, "example": { "snippetWindowSize": 200, "maxSnippets": 10, "matchWholeWordsOnly": true, "startSnippetMatchAtPage": 0, "endSnippetMatchAtPage": -1, "enableSynonymSearch": false, "snippetMatchIgnoreCase": true } }, "matchingPhraseList": { "type": "array", "items": { "type": "string" }, "example": [ "agreements over $20k from last year", "agreements with keyword \"Force Majeure\"", "agreement clauses that are materially significant", "agreements over $20k with liability clauses" ] }, "searchResultEmail": { "type": "object", "properties": { "subject": { "type": "string", "description": "Email subject" }, "body": { "type": "string", "description": "Base64 encoding of email body in HTML" } }, "example": { "subject": "Acme NDA 2020 Report", "body": "PGRpdiBpZD0iYm9keSI+...Q+MjAyMC0wOC0wNVQyMzoyOTo1Mi4wMDArMDAwMDwvdGQ+ICAgICAgPC90cj4gIDwvdGFibGU+PC9kaXY+PC9kaXY+PC9kaXY+" } }, "docSupportInfo": { "type": "array", "items": { "type": "object" }, "example": { "pdf": { "contentType": "application/pdf", "snippetSupported": true, "conversionSupported": [ "text" ], "reportSupported": true }, "docx": { "contentType": "application/vnd.openxmlformats-officedocument", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "doc": { "contentType": "application/msword", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "text": { "contentType": "text/plain", "snippetSupported": true, "conversionSupported": [ "text" ], "reportSupported": false }, "rtf": { "contentType": "text/plain", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "csv": { "contentType": "application/csv", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "xls": { "contentType": "application/vnd.ms-excel", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "xlsx": { "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": true }, "ppt": { "contentType": "application/vnd.ms-powerpoint", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "pptx": { "contentType": "application/vnd.openxmlformats-officedocument.presentationml.presentation", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false }, "html": { "contentType": "text/html", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": true }, "default": { "contentType": "application/octet-stream", "snippetSupported": true, "conversionSupported": [ "pdf", "html", "text" ], "reportSupported": false } } } }, "securitySchemes": { "BearerAuth": { "type": "apiKey", "name": "Authorization", "in": "header" }, "APIKeyAuth": { "type": "apiKey", "name": "X-API-Key", "in": "header" } } } }