Data2CRM.API
<p>Make use of our in-depth documentation to get more information about the various functions of the service
COMMUNITYNO AUTH0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "api-2445581398133.apicast.io:443",
"basePath": "/v1",
"info": {
"description": "<p>Make use of our in-depth documentation to get more information about the various functions of the service. Those willing to explore the mechanics of Data2CRM.API can test it in live regime using the short code samples.</p><p>Select CRM: <span id=\"docs-select-crm\" style=\"font-weight: bold\">Loading... please wait</span></p><p>Here are the API access keys:<br><b>X-API2CRM-USER-KEY</b>: <span id=\"docs-user-key\">e2a6379ab878ae7e58119d4ec842bf9c</span><br><b>X-API2CRM-APPLICATION-KEY</b>: <span id=\"docs-crm-key\">7ae5b17008fb414d84981191cf3b66a476ef8bef</span></p><p id=\"docs-crm-access\">The CRM access details are:<br><b>URL</b>: <a id=\"docs-crm-url\" href=\"https://login.salesforce.com/\" target=\"_blank\">https://login.salesforce.com/</a><br><b>E-mail / Username</b>: <span id=\"docs-crm-username\">developers.data2crm.api+1@magneticone.com</span><br><b>Password</b>: <span id=\"docs-crm-password\">data2crmapi123</span></p>",
"title": "Data2CRM.API",
"version": "1",
"x-logo": {
"backgroundColor": "#3089CF",
"url": "https://api.apis.guru/v2/cache/logo/https_s3.amazonaws.com_enterprise-multitenant.3scale.net.3scale.net_data2crm-api_2445581398133_profiles_logos_medium_data2crm_api.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://app.api2crm.com/swagger/spec/data2crm_api.json",
"version": "2.0"
}
],
"x-providerName": "data2crm.com"
},
"externalDocs": {
"url": "http://www.data2crm.com/api/"
},
"responses": {
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"406": {
"description": "Not Acceptable"
},
"415": {
"description": "Unsupported Media Type"
}
},
"tags": [
{
"description": "Account Operations",
"name": "account"
},
{
"description": "Application Operations",
"name": "application"
},
{
"description": "Attachment Operations",
"name": "attachment"
},
{
"description": "Call Operations",
"name": "call"
},
{
"description": "Campaign Operations",
"name": "campaign"
},
{
"description": "Case Operations",
"name": "case"
},
{
"description": "Comment Operations",
"name": "comment"
},
{
"description": "Contact Operations",
"name": "contact"
},
{
"description": "Field Operations",
"name": "field"
},
{
"description": "Field Item Operations",
"name": "fieldItem"
},
{
"description": "Email Operations",
"name": "email"
},
{
"description": "Entity Operations",
"name": "entity"
},
{
"description": "Entity Item Operations",
"name": "entityItem"
},
{
"description": "Event Operations",
"name": "event"
},
{
"description": "Internal User Operations",
"name": "internalUser"
},
{
"description": "Invoice Operations",
"name": "invoice"
},
{
"description": "InvoiceItem Operations",
"name": "invoiceItem"
},
{
"description": "Lead Operations",
"name": "lead"
},
{
"description": "Meeting Operations",
"name": "meeting"
},
{
"description": "Note Operations",
"name": "note"
},
{
"description": "Opportunity Operations",
"name": "opportunity"
},
{
"description": "OpportunityProduct Operations",
"name": "opportunityProduct"
},
{
"description": "Platform Operations",
"name": "platform"
},
{
"description": "Post Operations",
"name": "post"
},
{
"description": "PriceBook Operations",
"name": "priceBook"
},
{
"description": "PriceBookItem Operations",
"name": "priceBookItem"
},
{
"description": "Product Operations",
"name": "product"
},
{
"description": "Project Operations",
"name": "project"
},
{
"description": "Quote Operations",
"name": "quote"
},
{
"description": "QuoteItem Operations",
"name": "quoteItem"
},
{
"description": "Request Operations",
"name": "request"
},
{
"description": "Tag Operations",
"name": "tag"
},
{
"description": "Task Operations",
"name": "task"
},
{
"description": "Ticket Operations",
"name": "ticket"
},
{
"description": "User Operations",
"name": "user"
}
],
"paths": {
"/application": {
"post": {
"consumes": [
"application/json"
],
"description": "Add application into the system",
"operationId": "createApplicationEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Add application into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationEntityWrite"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ApplicationEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for application",
"tags": [
"application"
]
}
},
"/application/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all applications from the system",
"operationId": "getApplicationCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for application",
"tags": [
"application"
]
}
},
"/application/entity/account": {
"post": {
"consumes": [
"application/json"
],
"description": "Add account into the system",
"operationId": "createAccountEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add account into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccountEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/AccountEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for account",
"tags": [
"account"
]
}
},
"/application/entity/account/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for accounts",
"operationId": "getAccountAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for account",
"tags": [
"account"
]
}
},
"/application/entity/account/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteAccountCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for account",
"tags": [
"account"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add account into the system",
"operationId": "createAccountEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add account into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for account",
"tags": [
"account"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateAccountEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for account",
"tags": [
"account"
]
}
},
"/application/entity/account/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all accounts from the system",
"operationId": "getAccountCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for account",
"tags": [
"account"
]
}
},
"/application/entity/account/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for accounts",
"operationId": "getAccountDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccountDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for account",
"tags": [
"account"
]
}
},
"/application/entity/account/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all accounts from the system",
"operationId": "getAccountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/AccountEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for account",
"tags": [
"account"
]
}
},
"/application/entity/account/{account_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete account information",
"operationId": "deleteAccountEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Account Identifier",
"in": "path",
"name": "account_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for account",
"tags": [
"account"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return account information",
"operationId": "getAccountEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Account Identifier",
"in": "path",
"name": "account_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccountEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for account",
"tags": [
"account"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update account information",
"operationId": "updateAccountEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Account Identifier",
"in": "path",
"name": "account_id",
"required": true,
"type": "string"
},
{
"description": "Update account information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccountEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccountEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for account",
"tags": [
"account"
]
}
},
"/application/entity/attachment": {
"post": {
"consumes": [
"application/json"
],
"description": "Add attachment into the system",
"operationId": "createAttachmentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add attachment into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AttachmentEntityWrite"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/AttachmentEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for attachments",
"operationId": "getAttachmentAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteAttachmentCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for attachment",
"tags": [
"attachment"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add attachment into the system",
"operationId": "createAttachmentEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add attachment into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for attachment",
"tags": [
"attachment"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateAttachmentEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all attachments from the system",
"operationId": "getAttachmentCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for attachments",
"operationId": "getAttachmentDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AttachmentDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all attachments from the system",
"operationId": "getAttachmentCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/AttachmentEntityList"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/attachment/{attachment_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete attachment information",
"operationId": "deleteAttachmentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Attachment Identifier",
"in": "path",
"name": "attachment_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for attachment",
"tags": [
"attachment"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return attachment information",
"operationId": "getAttachmentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Attachment Identifier",
"in": "path",
"name": "attachment_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AttachmentEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for attachment",
"tags": [
"attachment"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update attachment information",
"operationId": "updateAttachmentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Attachment Identifier",
"in": "path",
"name": "attachment_id",
"required": true,
"type": "string"
},
{
"description": "Update attachment information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AttachmentEntityWrite"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AttachmentEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for attachment",
"tags": [
"attachment"
]
}
},
"/application/entity/call": {
"post": {
"consumes": [
"application/json"
],
"description": "Add call into the system",
"operationId": "createCallEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add call into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CallEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CallEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for call",
"tags": [
"call"
]
}
},
"/application/entity/call/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for calls",
"operationId": "getCallAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for call",
"tags": [
"call"
]
}
},
"/application/entity/call/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteCallCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for call",
"tags": [
"call"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add call into the system",
"operationId": "createCallEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add call into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for call",
"tags": [
"call"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateCallEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for call",
"tags": [
"call"
]
}
},
"/application/entity/call/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all calls from the system",
"operationId": "getCallCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for call",
"tags": [
"call"
]
}
},
"/application/entity/call/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for calls",
"operationId": "getCallDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CallDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for call",
"tags": [
"call"
]
}
},
"/application/entity/call/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all calls from the system",
"operationId": "getCallCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/CallEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for call",
"tags": [
"call"
]
}
},
"/application/entity/call/{call_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete call information",
"operationId": "deleteCallEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Call Identifier",
"in": "path",
"name": "call_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for call",
"tags": [
"call"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return call information",
"operationId": "getCallEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Call Identifier",
"in": "path",
"name": "call_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CallEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for call",
"tags": [
"call"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update call information",
"operationId": "updateCallEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Call Identifier",
"in": "path",
"name": "call_id",
"required": true,
"type": "string"
},
{
"description": "Update call information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CallEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CallEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for call",
"tags": [
"call"
]
}
},
"/application/entity/campaign": {
"post": {
"consumes": [
"application/json"
],
"description": "Add campaign into the system",
"operationId": "createCampaignEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add campaign into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CampaignEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CampaignEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for campaigns",
"operationId": "getCampaignAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteCampaignCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for campaign",
"tags": [
"campaign"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add campaign into the system",
"operationId": "createCampaignEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add campaign into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for campaign",
"tags": [
"campaign"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateCampaignEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all campaigns from the system",
"operationId": "getCampaignCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for campaigns",
"operationId": "getCampaignDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CampaignDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all campaigns from the system",
"operationId": "getCampaignCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/CampaignEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/campaign/{campaign_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete campaign information",
"operationId": "deleteCampaignEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Campaign Identifier",
"in": "path",
"name": "campaign_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for campaign",
"tags": [
"campaign"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return campaign information",
"operationId": "getCampaignEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Campaign Identifier",
"in": "path",
"name": "campaign_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CampaignEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for campaign",
"tags": [
"campaign"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update campaign information",
"operationId": "updateCampaignEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Campaign Identifier",
"in": "path",
"name": "campaign_id",
"required": true,
"type": "string"
},
{
"description": "Update campaign information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CampaignEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CampaignEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for campaign",
"tags": [
"campaign"
]
}
},
"/application/entity/case": {
"post": {
"consumes": [
"application/json"
],
"description": "Add case into the system",
"operationId": "createCaseEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add case into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CasesEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CasesEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for case",
"tags": [
"case"
]
}
},
"/application/entity/case/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for cases",
"operationId": "getCaseAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for case",
"tags": [
"case"
]
}
},
"/application/entity/case/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteCaseCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for case",
"tags": [
"case"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add case into the system",
"operationId": "createCaseEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add case into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for case",
"tags": [
"case"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateCaseEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for case",
"tags": [
"case"
]
}
},
"/application/entity/case/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all cases from the system",
"operationId": "getCaseCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for case",
"tags": [
"case"
]
}
},
"/application/entity/case/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for cases",
"operationId": "getCaseDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CaseDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for case",
"tags": [
"case"
]
}
},
"/application/entity/case/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all cases from the system",
"operationId": "getCaseCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/CasesEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for case",
"tags": [
"case"
]
}
},
"/application/entity/case/{case_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete case information",
"operationId": "deleteCaseEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Case Identifier",
"in": "path",
"name": "case_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for case",
"tags": [
"case"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return case information",
"operationId": "getCaseEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Case Identifier",
"in": "path",
"name": "case_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CasesEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for case",
"tags": [
"case"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update case information",
"operationId": "updateCaseEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Case Identifier",
"in": "path",
"name": "case_id",
"required": true,
"type": "string"
},
{
"description": "Update case information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CasesEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CasesEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for case",
"tags": [
"case"
]
}
},
"/application/entity/comment": {
"post": {
"consumes": [
"application/json"
],
"description": "Add comment into the system",
"operationId": "createCommentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add comment into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CommentEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CommentEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for comments",
"operationId": "getCommentAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteCommentCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for comment",
"tags": [
"comment"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add comment into the system",
"operationId": "createCommentEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add comment into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for comment",
"tags": [
"comment"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateCommentEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all comments from the system",
"operationId": "getCommentCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for comments",
"operationId": "getCommentDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommentDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all comments from the system",
"operationId": "getCommentCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/CommentEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for comment",
"tags": [
"comment"
]
}
},
"/application/entity/comment/{comment_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete comment information",
"operationId": "deleteCommentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Comment Identifier",
"in": "path",
"name": "comment_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for comment",
"tags": [
"comment"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return comment information",
"operationId": "getCommentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Comment Identifier",
"in": "path",
"name": "comment_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommentEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for comment",
"tags": [
"comment"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update comment information",
"operationId": "updateCommentEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Comment Identifier",
"in": "path",
"name": "comment_id",
"required": true,
"type": "string"
},
{
"description": "Update comment information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CommentEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CommentEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for comment",
"tags": [
"comment"
]
}
},
"/application/entity/contact": {
"post": {
"consumes": [
"application/json"
],
"description": "Add contact into the system",
"operationId": "createContactEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add contact into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ContactEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ContactEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for contacts",
"operationId": "getContactAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteContactCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for contact",
"tags": [
"contact"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add contact into the system",
"operationId": "createContactEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add contact into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for contact",
"tags": [
"contact"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateContactEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all contacts from the system",
"operationId": "getContactCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for contacts",
"operationId": "getContactDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContactDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all contacts from the system",
"operationId": "getContactCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/ContactEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for contact",
"tags": [
"contact"
]
}
},
"/application/entity/contact/{contact_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete contact information",
"operationId": "deleteContactEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Contact Identifier",
"in": "path",
"name": "contact_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for contact",
"tags": [
"contact"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return contact information",
"operationId": "getContactEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Contact Identifier",
"in": "path",
"name": "contact_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContactEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for contact",
"tags": [
"contact"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update contact information",
"operationId": "updateContactEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Contact Identifier",
"in": "path",
"name": "contact_id",
"required": true,
"type": "string"
},
{
"description": "Update contact information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ContactEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContactEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for contact",
"tags": [
"contact"
]
}
},
"/application/entity/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all entities from the system",
"operationId": "getEntityCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for entity",
"tags": [
"entity"
]
}
},
"/application/entity/email": {
"post": {
"consumes": [
"application/json"
],
"description": "Add email into the system",
"operationId": "createEmailEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add email into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EmailEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/EmailEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for email",
"tags": [
"email"
]
}
},
"/application/entity/email/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for emails",
"operationId": "getEmailAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for email",
"tags": [
"email"
]
}
},
"/application/entity/email/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteEmailCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for email",
"tags": [
"email"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add email into the system",
"operationId": "createEmailEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add email into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for email",
"tags": [
"email"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateEmailEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for email",
"tags": [
"email"
]
}
},
"/application/entity/email/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all emails from the system",
"operationId": "getEmailCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for email",
"tags": [
"email"
]
}
},
"/application/entity/email/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for emails",
"operationId": "getEmailDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EmailDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for email",
"tags": [
"email"
]
}
},
"/application/entity/email/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all emails from the system",
"operationId": "getEmailCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/EmailEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for email",
"tags": [
"email"
]
}
},
"/application/entity/email/{email_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete email information",
"operationId": "deleteEmailEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Email Identifier",
"in": "path",
"name": "email_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for email",
"tags": [
"email"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return email information",
"operationId": "getEmailEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Email Identifier",
"in": "path",
"name": "email_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EmailEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for email",
"tags": [
"email"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update email information",
"operationId": "updateEmailEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Email Identifier",
"in": "path",
"name": "email_id",
"required": true,
"type": "string"
},
{
"description": "Update email information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EmailEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EmailEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for email",
"tags": [
"email"
]
}
},
"/application/entity/event": {
"post": {
"consumes": [
"application/json"
],
"description": "Add event into the system",
"operationId": "createEventEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add event into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EventEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/EventEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for event",
"tags": [
"event"
]
}
},
"/application/entity/event/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for events",
"operationId": "getEventAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for event",
"tags": [
"event"
]
}
},
"/application/entity/event/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteEventCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for event",
"tags": [
"event"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add event into the system",
"operationId": "createEventEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add event into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for event",
"tags": [
"event"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateEventEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for event",
"tags": [
"event"
]
}
},
"/application/entity/event/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all events from the system",
"operationId": "getEventCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for event",
"tags": [
"event"
]
}
},
"/application/entity/event/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for events",
"operationId": "getEventDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for event",
"tags": [
"event"
]
}
},
"/application/entity/event/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all events from the system",
"operationId": "getEventCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/EventEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for event",
"tags": [
"event"
]
}
},
"/application/entity/event/{event_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete event information",
"operationId": "deleteEventEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Event Identifier",
"in": "path",
"name": "event_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for event",
"tags": [
"event"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return event information",
"operationId": "getEventEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Event Identifier",
"in": "path",
"name": "event_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for event",
"tags": [
"event"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update event information",
"operationId": "updateEventEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Event Identifier",
"in": "path",
"name": "event_id",
"required": true,
"type": "string"
},
{
"description": "Update event information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EventEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for event",
"tags": [
"event"
]
}
},
"/application/entity/invoice": {
"post": {
"consumes": [
"application/json"
],
"description": "Add invoice into the system",
"operationId": "createInvoiceEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add invoice into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InvoiceEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/InvoiceEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for invoices",
"operationId": "getInvoiceAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteInvoiceCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for invoice",
"tags": [
"invoice"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add invoice into the system",
"operationId": "createInvoiceEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add invoice into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for invoice",
"tags": [
"invoice"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateInvoiceEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all invoices from the system",
"operationId": "getInvoiceCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for invoices",
"operationId": "getInvoiceDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all invoices from the system",
"operationId": "getInvoiceCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/InvoiceEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoice/{invoice_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete invoice information",
"operationId": "deleteInvoiceEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Invoice Identifier",
"in": "path",
"name": "invoice_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for invoice",
"tags": [
"invoice"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return invoice information",
"operationId": "getInvoiceEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Invoice Identifier",
"in": "path",
"name": "invoice_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for invoice",
"tags": [
"invoice"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update invoice information",
"operationId": "updateInvoiceEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Invoice Identifier",
"in": "path",
"name": "invoice_id",
"required": true,
"type": "string"
},
{
"description": "Update invoice information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InvoiceEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for invoice",
"tags": [
"invoice"
]
}
},
"/application/entity/invoiceItem": {
"post": {
"consumes": [
"application/json"
],
"description": "Add invoiceItem into the system",
"operationId": "createInvoiceItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add invoiceItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InvoiceItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/InvoiceItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for invoiceItems",
"operationId": "getInvoiceItemAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteInvoiceItemCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for invoiceItem",
"tags": [
"invoiceItem"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add invoiceItem into the system",
"operationId": "createInvoiceItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add invoiceItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for invoiceItem",
"tags": [
"invoiceItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateInvoiceItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all invoiceItems from the system",
"operationId": "getInvoiceItemCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for invoiceItems",
"operationId": "getInvoiceItemDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceItemDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all invoiceItems from the system",
"operationId": "getInvoiceItemCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/InvoiceItemEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/invoiceItem/{invoiceItem_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete invoiceItem information",
"operationId": "deleteInvoiceItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Invoice Item Identifier",
"in": "path",
"name": "invoiceItem_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for invoiceItem",
"tags": [
"invoiceItem"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return invoiceItem information",
"operationId": "getInvoiceItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Invoice Item Identifier",
"in": "path",
"name": "invoiceItem_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceItemEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for invoiceItem",
"tags": [
"invoiceItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update invoiceItem information",
"operationId": "updateInvoiceItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Invoice Item Identifier",
"in": "path",
"name": "invoiceItem_id",
"required": true,
"type": "string"
},
{
"description": "Update invoiceItem information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InvoiceItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InvoiceItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for invoiceItem",
"tags": [
"invoiceItem"
]
}
},
"/application/entity/lead": {
"post": {
"consumes": [
"application/json"
],
"description": "Add lead into the system",
"operationId": "createLeadEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add lead into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/LeadEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/LeadEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for leads",
"operationId": "getLeadAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteLeadCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for lead",
"tags": [
"lead"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add lead into the system",
"operationId": "createLeadEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add lead into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for lead",
"tags": [
"lead"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateLeadEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all leads from the system",
"operationId": "getLeadCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for leads",
"operationId": "getLeadDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LeadDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all leads from the system",
"operationId": "getLeadCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/LeadEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for lead",
"tags": [
"lead"
]
}
},
"/application/entity/lead/{lead_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete lead information",
"operationId": "deleteLeadEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Lead Identifier",
"in": "path",
"name": "lead_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for lead",
"tags": [
"lead"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return lead information",
"operationId": "getLeadEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Lead Identifier",
"in": "path",
"name": "lead_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LeadEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for lead",
"tags": [
"lead"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update lead information",
"operationId": "updateLeadEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Lead Identifier",
"in": "path",
"name": "lead_id",
"required": true,
"type": "string"
},
{
"description": "Update lead information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/LeadEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LeadEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for lead",
"tags": [
"lead"
]
}
},
"/application/entity/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all entities from the system",
"operationId": "getEntityCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/EntityEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for entity",
"tags": [
"entity"
]
}
},
"/application/entity/meeting": {
"post": {
"consumes": [
"application/json"
],
"description": "Add meeting into the system",
"operationId": "createMeetingEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add meeting into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MeetingEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/MeetingEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for meetings",
"operationId": "getMeetingAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteMeetingCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for meeting",
"tags": [
"meeting"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add meeting into the system",
"operationId": "createMeetingEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add meeting into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for meeting",
"tags": [
"meeting"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateMeetingEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all meetings from the system",
"operationId": "getMeetingCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for meetings",
"operationId": "getMeetingDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MeetingDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all meetings from the system",
"operationId": "getMeetingCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/MeetingEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/meeting/{meeting_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete meeting information",
"operationId": "deleteMeetingEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Meeting Identifier",
"in": "path",
"name": "meeting_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for meeting",
"tags": [
"meeting"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return meeting information",
"operationId": "getMeetingEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Meeting Identifier",
"in": "path",
"name": "meeting_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MeetingEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for meeting",
"tags": [
"meeting"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update meeting information",
"operationId": "updateMeetingEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Meeting Identifier",
"in": "path",
"name": "meeting_id",
"required": true,
"type": "string"
},
{
"description": "Update meeting information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MeetingEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MeetingEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for meeting",
"tags": [
"meeting"
]
}
},
"/application/entity/note": {
"post": {
"consumes": [
"application/json"
],
"description": "Add note into the system",
"operationId": "createNoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add note into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/NoteEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/NoteEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for note",
"tags": [
"note"
]
}
},
"/application/entity/note/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for notes",
"operationId": "getNoteAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for note",
"tags": [
"note"
]
}
},
"/application/entity/note/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteNoteCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for note",
"tags": [
"note"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add note into the system",
"operationId": "createNoteEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add note into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for note",
"tags": [
"note"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateNoteEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for note",
"tags": [
"note"
]
}
},
"/application/entity/note/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all notes from the system",
"operationId": "getNoteCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for note",
"tags": [
"note"
]
}
},
"/application/entity/note/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for notes",
"operationId": "getNoteDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/NoteDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for note",
"tags": [
"note"
]
}
},
"/application/entity/note/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all notes from the system",
"operationId": "getNoteCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NoteEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for note",
"tags": [
"note"
]
}
},
"/application/entity/note/{note_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete note information",
"operationId": "deleteNoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Note Identifier",
"in": "path",
"name": "note_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for note",
"tags": [
"note"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return note information",
"operationId": "getNoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Note Identifier",
"in": "path",
"name": "note_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/NoteEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for note",
"tags": [
"note"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update note information",
"operationId": "updateNoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Note Identifier",
"in": "path",
"name": "note_id",
"required": true,
"type": "string"
},
{
"description": "Update note information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/NoteEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/NoteEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for note",
"tags": [
"note"
]
}
},
"/application/entity/opportunity": {
"post": {
"consumes": [
"application/json"
],
"description": "Add opportunity into the system",
"operationId": "createOpportunityEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add opportunity into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OpportunityEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/OpportunityEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for opportunities",
"operationId": "getOpportunityAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteOpportunityCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for opportunity",
"tags": [
"opportunity"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add opportunity into the system",
"operationId": "createOpportunityEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add opportunity into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for opportunity",
"tags": [
"opportunity"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateOpportunityEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all opportunities from the system",
"operationId": "getOpportunityCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for opportunities",
"operationId": "getOpportunityDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all opportunities from the system",
"operationId": "getOpportunityCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/OpportunityEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunity/{opportunity_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete opportunity information",
"operationId": "deleteOpportunityEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Opportunity Identifier",
"in": "path",
"name": "opportunity_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for opportunity",
"tags": [
"opportunity"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return opportunity information",
"operationId": "getOpportunityEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Opportunity Identifier",
"in": "path",
"name": "opportunity_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for opportunity",
"tags": [
"opportunity"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update opportunity information",
"operationId": "updateOpportunityEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Opportunity Identifier",
"in": "path",
"name": "opportunity_id",
"required": true,
"type": "string"
},
{
"description": "Update opportunity information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OpportunityEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for opportunity",
"tags": [
"opportunity"
]
}
},
"/application/entity/opportunityProduct": {
"post": {
"consumes": [
"application/json"
],
"description": "Add opportunityProduct into the system",
"operationId": "createOpportunityProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add opportunityProduct into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OpportunityProductEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/OpportunityProductEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for opportunityProducts",
"operationId": "getOpportunityProductAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteOpportunityProductCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for opportunityProduct",
"tags": [
"opportunityProduct"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add opportunityProduct into the system",
"operationId": "createOpportunityProductEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add opportunityProduct into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for opportunityProduct",
"tags": [
"opportunityProduct"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateOpportunityProductEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all opportunityProducts from the system",
"operationId": "getOpportunityProductCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for opportunityProducts",
"operationId": "getOpportunityProductDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityProductDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all opportunityProducts from the system",
"operationId": "getOpportunityProductCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/OpportunityProductEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/opportunityProduct/{opportunityProduct_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete opportunityProduct information",
"operationId": "deleteOpportunityProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Opportunity Product Identifier",
"in": "path",
"name": "opportunityProduct_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for opportunityProduct",
"tags": [
"opportunityProduct"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return opportunityProduct information",
"operationId": "getOpportunityProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Opportunity Product Identifier",
"in": "path",
"name": "opportunityProduct_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityProductEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for opportunityProduct",
"tags": [
"opportunityProduct"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update opportunityProduct information",
"operationId": "updateOpportunityProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Opportunity Product Identifier",
"in": "path",
"name": "opportunityProduct_id",
"required": true,
"type": "string"
},
{
"description": "Update opportunityProduct information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OpportunityProductEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OpportunityProductEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for opportunityProduct",
"tags": [
"opportunityProduct"
]
}
},
"/application/entity/post": {
"post": {
"consumes": [
"application/json"
],
"description": "Add post into the system",
"operationId": "createPostEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add post into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PostEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/PostEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for post",
"tags": [
"post"
]
}
},
"/application/entity/post/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for posts",
"operationId": "getPostAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for post",
"tags": [
"post"
]
}
},
"/application/entity/post/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deletePostCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for post",
"tags": [
"post"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add post into the system",
"operationId": "createPostEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add post into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for post",
"tags": [
"post"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updatePostEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for post",
"tags": [
"post"
]
}
},
"/application/entity/post/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all posts from the system",
"operationId": "getPostCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for post",
"tags": [
"post"
]
}
},
"/application/entity/post/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for posts",
"operationId": "getPostDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PostDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for post",
"tags": [
"post"
]
}
},
"/application/entity/post/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all posts from the system",
"operationId": "getPostCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/PostEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for post",
"tags": [
"post"
]
}
},
"/application/entity/post/{post_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete post information",
"operationId": "deletePostEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Post Identifier",
"in": "path",
"name": "post_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for post",
"tags": [
"post"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return post information",
"operationId": "getPostEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Post Identifier",
"in": "path",
"name": "post_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PostEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for post",
"tags": [
"post"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update post information",
"operationId": "updatePostEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Post Identifier",
"in": "path",
"name": "post_id",
"required": true,
"type": "string"
},
{
"description": "Update post information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PostEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PostEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for post",
"tags": [
"post"
]
}
},
"/application/entity/priceBook": {
"post": {
"consumes": [
"application/json"
],
"description": "Add priceBook into the system",
"operationId": "createPriceBookEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add priceBook into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PriceBookEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/PriceBookEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for priceBooks",
"operationId": "getPriceBookAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deletePriceBookCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for priceBook",
"tags": [
"priceBook"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add priceBook into the system",
"operationId": "createPriceBookEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add priceBook into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for priceBook",
"tags": [
"priceBook"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updatePriceBookEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all priceBooks from the system",
"operationId": "getPriceBookCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for priceBooks",
"operationId": "getPriceBookDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all priceBooks from the system",
"operationId": "getPriceBookCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/PriceBookEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBook/{priceBook_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete priceBook information",
"operationId": "deletePriceBookEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "PriceBook Identifier",
"in": "path",
"name": "priceBook_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for priceBook",
"tags": [
"priceBook"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return priceBook information",
"operationId": "getPriceBookEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "PriceBook Identifier",
"in": "path",
"name": "priceBook_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for priceBook",
"tags": [
"priceBook"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update priceBook information",
"operationId": "updatePriceBookEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "PriceBook Identifier",
"in": "path",
"name": "priceBook_id",
"required": true,
"type": "string"
},
{
"description": "Update priceBook information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PriceBookEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for priceBook",
"tags": [
"priceBook"
]
}
},
"/application/entity/priceBookItem": {
"post": {
"consumes": [
"application/json"
],
"description": "Add priceBookItem into the system",
"operationId": "createPriceBookItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add priceBookItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PriceBookItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/PriceBookItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for priceBookItems",
"operationId": "getPriceBookItemAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deletePriceBookItemCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for priceBookItem",
"tags": [
"priceBookItem"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add priceBookItem into the system",
"operationId": "createPriceBookItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add priceBookItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for priceBookItem",
"tags": [
"priceBookItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updatePriceBookItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all priceBookItems from the system",
"operationId": "getPriceBookItemCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for priceBookItems",
"operationId": "getPriceBookItemDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookItemDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all priceBookItems from the system",
"operationId": "getPriceBookItemCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/PriceBookItemEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/priceBookItem/{priceBookItem_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete priceBookItem information",
"operationId": "deletePriceBookItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "PriceBookItem Identifier",
"in": "path",
"name": "priceBookItem_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for priceBookItem",
"tags": [
"priceBookItem"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return priceBookItem information",
"operationId": "getPriceBookItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "PriceBookItem Identifier",
"in": "path",
"name": "priceBookItem_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookItemEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for priceBookItem",
"tags": [
"priceBookItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update priceBookItem information",
"operationId": "updatePriceBookItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "PriceBookItem Identifier",
"in": "path",
"name": "priceBookItem_id",
"required": true,
"type": "string"
},
{
"description": "Update priceBookItem information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PriceBookItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PriceBookItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for priceBookItem",
"tags": [
"priceBookItem"
]
}
},
"/application/entity/product": {
"post": {
"consumes": [
"application/json"
],
"description": "Add product into the system",
"operationId": "createProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add product into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProductEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ProductEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for product",
"tags": [
"product"
]
}
},
"/application/entity/product/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for products",
"operationId": "getProductAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for product",
"tags": [
"product"
]
}
},
"/application/entity/product/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteProductCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for product",
"tags": [
"product"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add product into the system",
"operationId": "createProductEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add product into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for product",
"tags": [
"product"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateProductEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for product",
"tags": [
"product"
]
}
},
"/application/entity/product/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all products from the system",
"operationId": "getProductCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for product",
"tags": [
"product"
]
}
},
"/application/entity/product/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for products",
"operationId": "getProductDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProductDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for product",
"tags": [
"product"
]
}
},
"/application/entity/product/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all products from the system",
"operationId": "getProductCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/ProductEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for product",
"tags": [
"product"
]
}
},
"/application/entity/product/{product_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete product information",
"operationId": "deleteProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Product Identifier",
"in": "path",
"name": "product_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for product",
"tags": [
"product"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return product information",
"operationId": "getProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Product Identifier",
"in": "path",
"name": "product_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProductEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for product",
"tags": [
"product"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update product information",
"operationId": "updateProductEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Product Identifier",
"in": "path",
"name": "product_id",
"required": true,
"type": "string"
},
{
"description": "Update product information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProductEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProductEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for product",
"tags": [
"product"
]
}
},
"/application/entity/project": {
"post": {
"consumes": [
"application/json"
],
"description": "Add project into the system",
"operationId": "createProjectEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add project into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProjectEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ProjectEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for project",
"tags": [
"project"
]
}
},
"/application/entity/project/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for projects",
"operationId": "getProjectAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for project",
"tags": [
"project"
]
}
},
"/application/entity/project/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteProjectCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for project",
"tags": [
"project"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add project into the system",
"operationId": "createProjectEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add project into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for project",
"tags": [
"project"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateProjectEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for project",
"tags": [
"project"
]
}
},
"/application/entity/project/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all projects from the system",
"operationId": "getProjectCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for project",
"tags": [
"project"
]
}
},
"/application/entity/project/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for projects",
"operationId": "getProjectDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for project",
"tags": [
"project"
]
}
},
"/application/entity/project/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all projects from the system",
"operationId": "getProjectCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/ProjectEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for project",
"tags": [
"project"
]
}
},
"/application/entity/project/{project_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete project information",
"operationId": "deleteProjectEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Project Identifier",
"in": "path",
"name": "project_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for project",
"tags": [
"project"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return project information",
"operationId": "getProjectEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Project Identifier",
"in": "path",
"name": "project_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for project",
"tags": [
"project"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update project information",
"operationId": "updateProjectEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Project Identifier",
"in": "path",
"name": "project_id",
"required": true,
"type": "string"
},
{
"description": "Update project information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProjectEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for project",
"tags": [
"project"
]
}
},
"/application/entity/quote": {
"post": {
"consumes": [
"application/json"
],
"description": "Add quote into the system",
"operationId": "createQuoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add quote into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/QuoteEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/QuoteEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for quotes",
"operationId": "getQuoteAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteQuoteCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for quote",
"tags": [
"quote"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add quote into the system",
"operationId": "createQuoteEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add quote into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for quote",
"tags": [
"quote"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateQuoteEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all quotes from the system",
"operationId": "getQuoteCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for quotes",
"operationId": "getQuoteDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all quotes from the system",
"operationId": "getQuoteCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/QuoteEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quote/{quote_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete quote information",
"operationId": "deleteQuoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Quote Identifier",
"in": "path",
"name": "quote_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for quote",
"tags": [
"quote"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return quote information",
"operationId": "getQuoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Quote Identifier",
"in": "path",
"name": "quote_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for quote",
"tags": [
"quote"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update quote information",
"operationId": "updateQuoteEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Quote Identifier",
"in": "path",
"name": "quote_id",
"required": true,
"type": "string"
},
{
"description": "Update quote information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/QuoteEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for quote",
"tags": [
"quote"
]
}
},
"/application/entity/quoteItem": {
"post": {
"consumes": [
"application/json"
],
"description": "Add quoteItem into the system",
"operationId": "createQuoteItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add quoteItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/QuoteItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/QuoteItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for quoteItems",
"operationId": "getQuoteItemAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteQuoteItemCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for quoteItem",
"tags": [
"quoteItem"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add quoteItem into the system",
"operationId": "createQuoteItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add quoteItem into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for quoteItem",
"tags": [
"quoteItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateQuoteItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all quoteItems from the system",
"operationId": "getQuoteItemCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for quoteItems",
"operationId": "getQuoteItemDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteItemDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all quoteItems from the system",
"operationId": "getQuoteItemCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/QuoteItemEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/quoteItem/{quoteItem_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete quoteItem information",
"operationId": "deleteQuoteItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Quote Item Identifier",
"in": "path",
"name": "quoteItem_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for quoteItem",
"tags": [
"quoteItem"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return quoteItem information",
"operationId": "getQuoteItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Quote Item Identifier",
"in": "path",
"name": "quoteItem_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteItemEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for quoteItem",
"tags": [
"quoteItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update quoteItem information",
"operationId": "updateQuoteItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Quote Item Identifier",
"in": "path",
"name": "quoteItem_id",
"required": true,
"type": "string"
},
{
"description": "Update quoteItem information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/QuoteItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QuoteItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for quoteItem",
"tags": [
"quoteItem"
]
}
},
"/application/entity/tag": {
"post": {
"consumes": [
"application/json"
],
"description": "Add tag into the system",
"operationId": "createTagEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add tag into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TagEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/TagEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for tags",
"operationId": "getTagAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteTagCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for tag",
"tags": [
"tag"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add tag into the system",
"operationId": "createTagEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add tag into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for tag",
"tags": [
"tag"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateTagEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all tags from the system",
"operationId": "getTagCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for tags",
"operationId": "getTagDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TagDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all tags from the system",
"operationId": "getTagCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TagEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for tag",
"tags": [
"tag"
]
}
},
"/application/entity/tag/{tag_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete tag information",
"operationId": "deleteTagEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Tag Identifier",
"in": "path",
"name": "tag_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for tag",
"tags": [
"tag"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return tag information",
"operationId": "getTagEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Tag Identifier",
"in": "path",
"name": "tag_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TagEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for tag",
"tags": [
"tag"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update tag information",
"operationId": "updateTagEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Tag Identifier",
"in": "path",
"name": "tag_id",
"required": true,
"type": "string"
},
{
"description": "Update tag information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TagEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TagEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for tag",
"tags": [
"tag"
]
}
},
"/application/entity/task": {
"post": {
"consumes": [
"application/json"
],
"description": "Add task into the system",
"operationId": "createTaskEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add task into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TaskEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/TaskEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for task",
"tags": [
"task"
]
}
},
"/application/entity/task/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for tasks",
"operationId": "getTaskAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for task",
"tags": [
"task"
]
}
},
"/application/entity/task/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteTaskCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for task",
"tags": [
"task"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add task into the system",
"operationId": "createTaskEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add task into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for task",
"tags": [
"task"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateTaskEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for task",
"tags": [
"task"
]
}
},
"/application/entity/task/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all tasks from the system",
"operationId": "getTaskCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for task",
"tags": [
"task"
]
}
},
"/application/entity/task/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for tasks",
"operationId": "getTaskDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TaskDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for task",
"tags": [
"task"
]
}
},
"/application/entity/task/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all tasks from the system",
"operationId": "getTaskCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TaskEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for task",
"tags": [
"task"
]
}
},
"/application/entity/task/{task_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete task information",
"operationId": "deleteTaskEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Task Identifier",
"in": "path",
"name": "task_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for task",
"tags": [
"task"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return task information",
"operationId": "getTaskEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Task Identifier",
"in": "path",
"name": "task_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TaskEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for task",
"tags": [
"task"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update task information",
"operationId": "updateTaskEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Task Identifier",
"in": "path",
"name": "task_id",
"required": true,
"type": "string"
},
{
"description": "Update task information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TaskEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TaskEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for task",
"tags": [
"task"
]
}
},
"/application/entity/ticket": {
"post": {
"consumes": [
"application/json"
],
"description": "Add ticket into the system",
"operationId": "createTicketEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add ticket into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TicketEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/TicketEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "getTicketAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteTicketCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for ticket",
"tags": [
"ticket"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add ticket into the system",
"operationId": "createTicketEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add ticket into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for ticket",
"tags": [
"ticket"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateTicketEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all tickets from the system",
"operationId": "getTicketCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for tickets",
"operationId": "getTicketDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TicketDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all tickets from the system",
"operationId": "getTicketCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/TicketEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/ticket/{ticket_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete ticket information",
"operationId": "deleteTicketEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Ticket Identifier",
"in": "path",
"name": "ticket_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for ticket",
"tags": [
"ticket"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return ticket information",
"operationId": "getTicketEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Ticket Identifier",
"in": "path",
"name": "ticket_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TicketEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for ticket",
"tags": [
"ticket"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update ticket information",
"operationId": "updateTicketEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Ticket Identifier",
"in": "path",
"name": "ticket_id",
"required": true,
"type": "string"
},
{
"description": "Update ticket information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TicketEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TicketEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for ticket",
"tags": [
"ticket"
]
}
},
"/application/entity/user": {
"post": {
"consumes": [
"application/json"
],
"description": "Add user into the system",
"operationId": "createUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add user into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UserEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/UserEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for user",
"tags": [
"user"
]
}
},
"/application/entity/user/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for users",
"operationId": "getUserAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for user",
"tags": [
"user"
]
}
},
"/application/entity/user/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteUserCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for user",
"tags": [
"user"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add user into the system",
"operationId": "createUserEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Add user into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for user",
"tags": [
"user"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateUserEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for user",
"tags": [
"user"
]
}
},
"/application/entity/user/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all users from the system",
"operationId": "getUserCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for user",
"tags": [
"user"
]
}
},
"/application/entity/user/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for users",
"operationId": "getUserDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/UserDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for user",
"tags": [
"user"
]
}
},
"/application/entity/user/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all users from the system",
"operationId": "getUserCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/UserEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for user",
"tags": [
"user"
]
}
},
"/application/entity/user/{user_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete user information",
"operationId": "deleteUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "User Identifier",
"in": "path",
"name": "user_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for user",
"tags": [
"user"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return user information",
"operationId": "getUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "User Identifier",
"in": "path",
"name": "user_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/UserEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for user",
"tags": [
"user"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update user information",
"operationId": "updateUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "User Identifier",
"in": "path",
"name": "user_id",
"required": true,
"type": "string"
},
{
"description": "Update user information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UserEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/UserEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for user",
"tags": [
"user"
]
}
},
"/application/entity/{entity_id}": {
"get": {
"consumes": [
"application/json"
],
"description": "Return entity information",
"operationId": "getEntityEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EntityEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for entity",
"tags": [
"entity"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add entity item into the system",
"operationId": "createEntityItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Add entity item into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EntityItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/EntityItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/aggregate": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns aggregate for entity items",
"operationId": "getEntityItemAggregate",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Pipeline",
"in": "query",
"name": "pipeline",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Aggregate"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "AGGREGATE for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/bulk": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteEntityItemCollectionBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntity"
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE bulk for entityItem",
"tags": [
"entityItem"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add entity item into the system",
"operationId": "createEntityItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Add entity item into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST bulk for entityItem",
"tags": [
"entityItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateEntityItemEntityBulk",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BulkEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT bulk for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all entity items from the system",
"operationId": "getEntityItemCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for entity items",
"operationId": "getEntityItemDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EntityItemDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all entity items from the system",
"operationId": "getEntityItemCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "Find all unique values for selected field",
"enum": [
"false",
"true"
],
"in": "query",
"name": "unique",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/EntityItemEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/entity/{entity_id}/{entity_item_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete entity item information",
"operationId": "deleteEntityItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Entity Item Identifier",
"in": "path",
"name": "entity_item_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for entityItem",
"tags": [
"entityItem"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return entity item information",
"operationId": "getEntityItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Enable",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Data Build",
"enum": [
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-BUILD",
"required": false,
"type": "string"
},
{
"description": "Data Is Final",
"enum": [
"true",
"false"
],
"in": "header",
"name": "X-API2CRM-DATA-IS-FINAL",
"required": false,
"type": "string"
},
{
"description": "Data Strategy",
"enum": [
"simple"
],
"in": "header",
"name": "X-API2CRM-DATA-STRATEGY",
"required": false,
"type": "string"
},
{
"description": "Coherent Entities",
"in": "header",
"name": "X-API2CRM-DATA-COHERENT-ENTITIES",
"required": false,
"type": "string"
},
{
"description": "Data Is Actual",
"enum": [
"true"
],
"in": "header",
"name": "X-API2CRM-DATA-ALWAYS-ACTUAL",
"required": false,
"type": "string"
},
{
"description": "Data Actual At",
"format": "date-time",
"in": "header",
"name": "X-API2CRM-DATA-ACTUAL-AT",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}T(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}(\\-(0[0-9]|1[0-2])|\\+(0[0-9]|1[0-4]))[0-5][0-9]$/",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Entity Item Identifier",
"in": "path",
"name": "entity_item_id",
"required": true,
"type": "string"
},
{
"description": "Expand relations",
"in": "query",
"name": "expand",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EntityItemEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for entityItem",
"tags": [
"entityItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update entity item information",
"operationId": "updateEntityItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Return native response",
"enum": [
"false",
"true"
],
"in": "header",
"name": "X-API2CRM-NATIVE-ENABLE",
"required": false,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Entity Identifier",
"in": "path",
"name": "entity_id",
"required": true,
"type": "string"
},
{
"description": "Entity Item Identifier",
"in": "path",
"name": "entity_item_id",
"required": true,
"type": "string"
},
{
"description": "Update entity item information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EntityItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EntityItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for entityItem",
"tags": [
"entityItem"
]
}
},
"/application/field/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all fields from the system",
"operationId": "getFieldCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for field",
"tags": [
"field"
]
}
},
"/application/field/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all fields from the system",
"operationId": "getFieldCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/FieldEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for field",
"tags": [
"field"
]
}
},
"/application/field/{field_id}": {
"get": {
"consumes": [
"application/json"
],
"description": "Return field information",
"operationId": "getFieldEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FieldEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for field",
"tags": [
"field"
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Add field item into the system",
"operationId": "createFieldItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Add field item into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FieldItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/FieldItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for fieldItem",
"tags": [
"fieldItem"
]
}
},
"/application/field/{field_id}/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all field items from the system",
"operationId": "getFieldItemCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for fieldItem",
"tags": [
"fieldItem"
]
}
},
"/application/field/{field_id}/describe": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns describe for field items",
"operationId": "getFieldItemDescribe",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FieldItemDescribe"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "DESCRIBE for fieldItem",
"tags": [
"fieldItem"
]
}
},
"/application/field/{field_id}/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all fields from the system items",
"operationId": "getFieldItemCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/FieldItemEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for fieldItem",
"tags": [
"fieldItem"
]
}
},
"/application/field/{field_id}/{field_item_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete field item information",
"operationId": "deleteFieldItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Field Item Identifier",
"in": "path",
"name": "field_item_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for fieldItem",
"tags": [
"fieldItem"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return field item information",
"operationId": "getFieldItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Field Item Identifier",
"in": "path",
"name": "field_item_id",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FieldItemEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for fieldItem",
"tags": [
"fieldItem"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update field item information",
"operationId": "updateFieldItemEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Describe lifetime",
"in": "header",
"name": "X-API2CRM-DESCRIBE-LIFETIME",
"required": false,
"type": "string"
},
{
"description": "Field Identifier",
"in": "path",
"name": "field_id",
"required": true,
"type": "string"
},
{
"description": "Field Item Identifier",
"in": "path",
"name": "field_item_id",
"required": true,
"type": "string"
},
{
"description": "Update field item information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FieldItemEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FieldItemEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for fieldItem",
"tags": [
"fieldItem"
]
}
},
"/application/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all applications from the system",
"operationId": "getApplicationCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/ApplicationEntityList"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for application",
"tags": [
"application"
]
}
},
"/application/request": {
"post": {
"consumes": [
"application/json"
],
"description": "Execute request into the system",
"operationId": "createRequestEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"default": "7ae5b17008fb414d84981191cf3b66a476ef8bef",
"description": "Application Key",
"in": "header",
"name": "X-API2CRM-APPLICATION-KEY",
"required": true,
"type": "string"
},
{
"description": "Execute request into the system",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RequestEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/RequestEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for request",
"tags": [
"request"
]
}
},
"/application/{key}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete application information",
"operationId": "deleteApplicationEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Application key",
"in": "path",
"name": "key",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for application",
"tags": [
"application"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return application information",
"operationId": "getApplicationEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Application key",
"in": "path",
"name": "key",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApplicationEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for application",
"tags": [
"application"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update application information",
"operationId": "updateApplicationEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Application key",
"in": "path",
"name": "key",
"required": true,
"type": "string"
},
{
"description": "Update application information",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationEntityWrite"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApplicationEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for application",
"tags": [
"application"
]
}
},
"/platform/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all platforms from the system",
"operationId": "getPlatformCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/PlatformEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for platform",
"tags": [
"platform"
]
}
},
"/platform/{type}": {
"get": {
"consumes": [
"application/json"
],
"description": "Return platform information",
"operationId": "getPlatformEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "API2CRM user key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Platform type",
"in": "path",
"name": "type",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PlatformEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for platform",
"tags": [
"platform"
]
}
},
"/user": {
"post": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "createInternalUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InternalUserEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/InternalUserEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "POST for internalUser",
"tags": [
"internalUser"
]
}
},
"/user/count": {
"get": {
"consumes": [
"application/json"
],
"description": "Count all internal users from the system",
"operationId": "getInternalUserCountCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Count"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "COUNT for internalUser",
"tags": [
"internalUser"
]
}
},
"/user/list": {
"get": {
"consumes": [
"application/json"
],
"description": "Returns all internal users from the system",
"operationId": "getInternalUserCollection",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Amount of results (default: 25)",
"format": "int32",
"in": "query",
"name": "page_size",
"required": false,
"type": "integer"
},
{
"description": "Page to show (default: 1)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Filter",
"in": "query",
"name": "filter",
"required": false,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "Specifies ascending or descending sort on existing fields",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
},
{
"description": "All Application Requests from this date",
"format": "date",
"in": "query",
"name": "application_request_start",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}$/",
"required": false,
"type": "string"
},
{
"description": "All Application Requests until this date",
"format": "date",
"in": "query",
"name": "application_request_end",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}$/",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/InternalUserEntity"
},
"type": "array"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for internalUser",
"tags": [
"internalUser"
]
}
},
"/user/{internal_user_id}": {
"delete": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "deleteInternalUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Internal User Key",
"in": "path",
"name": "internal_user_id",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
},
"summary": "DELETE for internalUser",
"tags": [
"internalUser"
]
},
"get": {
"consumes": [
"application/json"
],
"description": "Return internal user information",
"operationId": "getInternalUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Internal User Key",
"in": "path",
"name": "internal_user_id",
"required": true,
"type": "string"
},
{
"description": "Comma-separated list of fields to include in the response",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
{
"description": "All Application Requests from this date",
"format": "date",
"in": "query",
"name": "application_request_start",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}$/",
"required": false,
"type": "string"
},
{
"description": "All Application Requests until this date",
"format": "date",
"in": "query",
"name": "application_request_end",
"pattern": "/^\\d{4}-\\d{2}-\\d{2}$/",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InternalUserEntity"
}
},
"404": {
"description": "Not Found"
}
},
"summary": "GET for internalUser",
"tags": [
"internalUser"
]
},
"put": {
"consumes": [
"application/json"
],
"description": "",
"operationId": "updateInternalUserEntity",
"parameters": [
{
"default": "e2a6379ab878ae7e58119d4ec842bf9c",
"description": "User Key",
"in": "header",
"name": "X-API2CRM-USER-KEY",
"required": true,
"type": "string"
},
{
"description": "Internal User Key",
"in": "path",
"name": "internal_user_id",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InternalUserEntity"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InternalUserEntityRelation"
}
},
"400": {
"description": "Client Error"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
},
"summary": "PUT for internalUser",
"tags": [
"internalUser"
]
}
}
},
"definitions": {
"AccountDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"AccountEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"annual_revenue": {
"description": "Annual Revenue",
"example": "23244.43552",
"type": "string"
},
"category": {
"description": "Category",
"example": "General",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Some long description",
"type": "string"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/Email"
},
"type": "array"
},
"employees": {
"description": "Employees",
"example": 230,
"type": "string"
},
"id": {
"description": "Account Identifier",
"example": "21312411",
"type": "string"
},
"industry": {
"description": "Industry",
"items": {
"type": "string"
},
"type": "array"
},
"messenger": {
"description": "Messenger",
"items": {
"$ref": "#/definitions/Messenger"
},
"type": "array"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"ownership": {
"description": "Ownership",
"example": "Public",
"type": "string"
},
"phone": {
"description": "Phone",
"items": {
"$ref": "#/definitions/Phone"
},
"type": "array"
},
"rating": {
"description": "Rating",
"example": "Active",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sic_code": {
"description": "SIC Code",
"example": "2895-1",
"type": "string"
},
"ticker_symbol": {
"description": "Ticker Symbol",
"example": "%",
"type": "string"
},
"type": {
"description": "Type",
"example": "Company",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"website": {
"description": "Website",
"items": {
"$ref": "#/definitions/Website"
},
"type": "array"
}
},
"type": "object"
},
"AccountEntityRelation": {
"properties": {
"id": {
"description": "Account Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"AccountRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/AccountEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Address": {
"properties": {
"city": {
"description": "City",
"example": "Brandenburg",
"type": "string"
},
"country": {
"description": "Country",
"example": "USA",
"type": "string"
},
"state": {
"description": "State",
"example": "NY",
"type": "string"
},
"street": {
"description": "Street",
"example": "NY",
"type": "string"
},
"type": {
"description": "Type",
"example": "billing",
"type": "string"
},
"zip": {
"description": "Zip",
"example": "47212",
"type": "string"
}
},
"type": "object"
},
"Aggregate": {
"properties": {
"id": {
"description": "Identifier",
"type": "string"
},
"result": {
"$ref": "#/definitions/ResultAggregate",
"description": "Result",
"type": "object"
}
},
"type": "object"
},
"ApplicationEntity": {
"properties": {
"authorization": {
"description": "Application authorization",
"type": "string"
},
"company": {
"$ref": "#/definitions/Company",
"description": "Application Company",
"type": "object"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Application description",
"type": "string"
},
"is_authorized": {
"description": "Is Authorized",
"type": "boolean"
},
"key": {
"description": "Application key",
"type": "string"
},
"last_used_at": {
"description": "Last Used At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"me": {
"$ref": "#/definitions/UserEntity",
"description": "Me",
"type": "object"
},
"plan": {
"description": "Application Plan",
"type": "string"
},
"requests_limit": {
"$ref": "#/definitions/RequestsLimit",
"description": "Application Requests Limit",
"type": "object"
},
"type": {
"description": "Application platform type",
"enum": [
"Bitrix24",
"MicrosoftDynamics",
"Vtiger",
"ZohoCRM",
"Salesforce",
"SalesforceSandbox",
"Solve360",
"Highrise",
"Insightly",
"HubSpot",
"PipelineDeals",
"SugarCRM",
"SuiteCRM",
"CapsuleCRM",
"Pipedrive",
"Infusionsoft",
"CloseIO",
"BaseCRM",
"Act",
"AgileCRM",
"ProsperWorks",
"FreshSales",
"Odoo",
"GSuite",
"ActPremiumWeb",
"Marketo",
"AmoCRM"
],
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"url": {
"description": "Application URL",
"type": "string"
},
"user_id": {
"description": "User ID",
"format": "int32",
"type": "integer"
},
"user_key": {
"description": "User Key",
"type": "string"
}
},
"type": "object"
},
"ApplicationEntityList": {
"properties": {
"authorization": {
"description": "Application authorization",
"type": "string"
},
"company": {
"$ref": "#/definitions/Company",
"description": "Application Company",
"type": "object"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Application description",
"type": "string"
},
"key": {
"description": "Application key",
"type": "string"
},
"last_used_at": {
"description": "Last Used At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"type": {
"description": "Application platform type",
"enum": [
"Bitrix24",
"MicrosoftDynamics",
"Vtiger",
"ZohoCRM",
"Salesforce",
"SalesforceSandbox",
"Solve360",
"Highrise",
"Insightly",
"HubSpot",
"PipelineDeals",
"SugarCRM",
"SuiteCRM",
"CapsuleCRM",
"Pipedrive",
"Infusionsoft",
"CloseIO",
"BaseCRM",
"Act",
"AgileCRM",
"ProsperWorks",
"FreshSales",
"Odoo",
"GSuite",
"ActPremiumWeb",
"Marketo",
"AmoCRM"
],
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"url": {
"description": "Application URL",
"type": "string"
},
"user_id": {
"description": "User ID",
"format": "int32",
"type": "integer"
},
"user_key": {
"description": "User Key",
"type": "string"
}
},
"type": "object"
},
"ApplicationEntityRelation": {
"properties": {
"key": {
"description": "Application key",
"type": "string"
}
},
"type": "object"
},
"ApplicationEntityWrite": {
"properties": {
"authorization": {
"description": "Application authorization",
"type": "string"
},
"credential": {
"$ref": "#/definitions/Credential",
"description": "Application credential",
"type": "object"
},
"description": {
"description": "Application description",
"type": "string"
},
"type": {
"description": "Application platform type",
"enum": [
"Bitrix24",
"MicrosoftDynamics",
"Vtiger",
"ZohoCRM",
"Salesforce",
"SalesforceSandbox",
"Solve360",
"Highrise",
"Insightly",
"HubSpot",
"PipelineDeals",
"SugarCRM",
"SuiteCRM",
"CapsuleCRM",
"Pipedrive",
"Infusionsoft",
"CloseIO",
"BaseCRM",
"Act",
"AgileCRM",
"ProsperWorks",
"FreshSales",
"Odoo",
"GSuite",
"ActPremiumWeb",
"Marketo",
"AmoCRM"
],
"type": "string"
}
},
"type": "object"
},
"AttachmentDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"AttachmentEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of attachment",
"type": "string"
},
"id": {
"description": "Attachment Identifier",
"example": "21312411",
"type": "string"
},
"link": {
"description": "Link",
"example": "http://s-10.server.host.com/f/2015/01/01/a/file.json",
"type": "string"
},
"mime_type": {
"description": "Mime Type",
"example": "application/json",
"type": "string"
},
"name": {
"description": "Name",
"example": "file.json",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"size": {
"description": "Size (in bytes)",
"example": 34345,
"format": "int32",
"type": "integer"
},
"title": {
"description": "Title",
"example": "Employees List File (json)",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"AttachmentEntityList": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of attachment",
"type": "string"
},
"id": {
"description": "Attachment Identifier",
"example": "21312411",
"type": "string"
},
"link": {
"description": "Link",
"example": "http://s-10.server.host.com/f/2015/01/01/a/file.json",
"type": "string"
},
"mime_type": {
"description": "Mime Type",
"example": "application/json",
"type": "string"
},
"name": {
"description": "Name",
"example": "file.json",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"size": {
"description": "Size (in bytes)",
"example": 34345,
"format": "int32",
"type": "integer"
},
"title": {
"description": "Title",
"example": "Employees List File (json)",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"AttachmentEntityRelation": {
"properties": {
"id": {
"description": "Attachment Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"AttachmentEntityWrite": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of attachment",
"type": "string"
},
"link": {
"description": "Link",
"example": "http://s-10.server.host.com/f/2015/01/01/a/file.json",
"type": "string"
},
"mime_type": {
"description": "Mime Type",
"example": "application/json",
"type": "string"
},
"name": {
"description": "Name",
"example": "file.json",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"size": {
"description": "Size (in bytes)",
"example": 34345,
"format": "int32",
"type": "integer"
},
"title": {
"description": "Title",
"example": "Employees List File (json)",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"AttachmentRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/AttachmentEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Authorization": {
"properties": {
"description": {
"description": "Description",
"type": "string"
},
"platform_credential": {
"description": "Credential",
"items": {
"$ref": "#/definitions/PlatformCredential"
},
"type": "array"
},
"type": {
"description": "Type",
"type": "string"
}
},
"type": "object"
},
"BulkEntity": {
"properties": {
"item": {
"description": "Item",
"items": {
"$ref": "#/definitions/Item"
},
"type": "array"
}
},
"type": "object"
},
"BulkEntityRelation": {
"properties": {
"id": {
"description": "Bulk Identifier",
"example": "21312411",
"type": "string"
},
"item": {
"description": "Item",
"items": {
"$ref": "#/definitions/Item"
},
"type": "array"
}
},
"type": "object"
},
"CallDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"CallEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of the call",
"type": "string"
},
"direction": {
"description": "Direction",
"example": "Inbound",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Call Identifier",
"example": "21312411",
"type": "string"
},
"purpose": {
"description": "Purpose",
"example": "Negotiation",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"result": {
"description": "Result",
"example": "Confirmed",
"type": "string"
},
"started_at": {
"description": "Started At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Planned",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Subject of the call",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CallEntityRelation": {
"properties": {
"id": {
"description": "Call Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"CallRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/CallEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"CampaignDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"CampaignEntity": {
"properties": {
"actual_cost": {
"description": "Actual Cost",
"example": 4235.91,
"format": "float",
"type": "number"
},
"budgeted_cost": {
"description": "Budgeted Cost",
"example": 4235.91,
"format": "float",
"type": "number"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description of the campaign",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"expected_end_at": {
"description": "Expected End At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"expected_response": {
"description": "Expected Response",
"example": 4235.91,
"format": "float",
"type": "number"
},
"expected_revenue": {
"description": "Expected Revenue",
"example": 4235.91,
"format": "float",
"type": "number"
},
"expected_start_at": {
"description": "Expected Start At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Campaign Identifier",
"example": "21312411",
"type": "string"
},
"is_active": {
"description": "Is Active",
"example": true,
"type": "boolean"
},
"name": {
"description": "Name",
"example": "Name of the campaign",
"type": "string"
},
"numbers_sent": {
"description": "Numbers Sent",
"example": 571,
"format": "int32",
"type": "integer"
},
"objective": {
"description": "Objective",
"example": "Objective of the campaign",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"started_at": {
"description": "Started At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"type": {
"description": "Type",
"example": "Telemarketing",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CampaignEntityRelation": {
"properties": {
"id": {
"description": "Campaign Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"CampaignRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/CampaignEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"CaseDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"CaseRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/CasesEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"CasesEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"expected_end_at": {
"description": "Expected End At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Case Identifier",
"example": "21312411",
"type": "string"
},
"internal_comments": {
"description": "Internal Comments",
"example": "Internal Comments",
"type": "string"
},
"is_closed": {
"description": "Is Closed",
"example": true,
"type": "boolean"
},
"is_escalated": {
"description": "Is Escalated",
"example": true,
"type": "boolean"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"origin": {
"description": "Origin",
"example": "phone",
"type": "string"
},
"pipeline_with_stage": {
"description": "Pipeline With Stage",
"example": "Default / Contacted",
"type": "string"
},
"priority": {
"description": "Priority",
"example": "high",
"type": "string"
},
"reason": {
"description": "Reason",
"example": "performance",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"resolution": {
"description": "Resolution",
"example": "fixed",
"type": "string"
},
"resolution_comments": {
"description": "Resolution Comments",
"example": "fixed",
"type": "string"
},
"satisfaction": {
"description": "Satisfaction",
"example": "very happy",
"type": "string"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Bill Wall",
"type": "string"
},
"type": {
"description": "Type",
"example": "Sales",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CasesEntityRelation": {
"properties": {
"id": {
"description": "Case Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"CommentDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"CommentEntity": {
"properties": {
"body": {
"description": "Body",
"example": "My first comment",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Comment Identifier",
"example": "21312411",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CommentEntityRelation": {
"properties": {
"id": {
"description": "Comment Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"CommentRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/CommentEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Company": {
"properties": {
"id": {
"description": "Company Item Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"ContactDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"ContactEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"birth_date": {
"description": "Birth Date",
"example": "1982-11-28",
"format": "date",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"department": {
"description": "Department",
"example": "D2C",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of the contact",
"type": "string"
},
"do_not_call": {
"description": "Do Not Call",
"type": "boolean"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/Email"
},
"type": "array"
},
"first_name": {
"description": "First Name",
"example": "Bill",
"type": "string"
},
"id": {
"description": "Contact Identifier",
"example": "21312411",
"type": "string"
},
"last_name": {
"description": "Last Name",
"example": "Wall",
"type": "string"
},
"lead_source": {
"description": "Lead Source",
"example": "Campaign",
"type": "string"
},
"messenger": {
"description": "Messenger",
"items": {
"$ref": "#/definitions/Messenger"
},
"type": "array"
},
"middle_name": {
"description": "Middle Name",
"example": "van",
"type": "string"
},
"name_suffix": {
"description": "Name Suffix",
"example": "Jr.",
"type": "string"
},
"phone": {
"description": "Phone",
"items": {
"$ref": "#/definitions/Phone"
},
"type": "array"
},
"position": {
"description": "Position (job)",
"example": "Director of Vendor Relations",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"salutation": {
"description": "Salutation",
"example": "Mr.",
"type": "string"
},
"sync_to_outlook": {
"description": "Sync To Outlook",
"type": "boolean"
},
"type": {
"description": "Type",
"example": "Bill Wall",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"website": {
"description": "Website",
"items": {
"$ref": "#/definitions/Website"
},
"type": "array"
}
},
"type": "object"
},
"ContactEntityRelation": {
"properties": {
"id": {
"description": "Contact Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"ContactRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/ContactEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Cost": {
"properties": {
"currency": {
"description": "Currency",
"example": "USD",
"type": "string"
},
"value": {
"description": "Value",
"example": 4235.91,
"format": "float",
"type": "number"
}
},
"type": "object"
},
"Count": {
"properties": {
"total": {
"description": "Total",
"example": 7612,
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CreateDescribe": {
"type": "object"
},
"Credential": {
"type": "object"
},
"Currency": {
"properties": {
"code": {
"description": "ISO 4217 Code",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"CustomField": {
"type": "object"
},
"DataCache": {
"type": "object"
},
"Discount": {
"properties": {
"percent_value": {
"description": "Percent Value",
"example": 4235.91,
"format": "float",
"type": "number"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
},
"value": {
"description": "Value",
"example": 4235.91,
"format": "float",
"type": "number"
}
},
"type": "object"
},
"Email": {
"properties": {
"address": {
"description": "Address",
"example": "bill.wall@mail.com",
"type": "string"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
}
},
"type": "object"
},
"EmailDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"EmailEntity": {
"properties": {
"bcc": {
"description": "BCC",
"items": {
"type": "string"
},
"type": "array"
},
"body": {
"description": "Body",
"example": "Body of the email",
"type": "string"
},
"cc": {
"description": "CC",
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"direction": {
"description": "Direction",
"example": "Outbound",
"type": "string"
},
"from": {
"description": "From",
"example": "bill.wall@mail.com",
"type": "string"
},
"id": {
"description": "Email Identifier",
"example": "21312411",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sent_at": {
"description": "Sent At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Sent",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Subject of the email",
"type": "string"
},
"to": {
"description": "To",
"items": {
"type": "string"
},
"type": "array"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"EmailEntityRelation": {
"properties": {
"id": {
"description": "Email Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"EmailRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/EmailEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"EntityEntity": {
"properties": {
"category": {
"description": "Category",
"enum": [
"basic",
"asset",
"additional"
],
"example": "basic",
"type": "string"
},
"collection": {
"description": "Collection",
"example": "Bug Integrations",
"type": "string"
},
"customField": {
"$ref": "#/definitions/CustomField",
"description": "Custom Field",
"type": "object"
},
"dataCache": {
"$ref": "#/definitions/DataCache",
"description": "Data Cache",
"type": "object"
},
"entity": {
"description": "Entity",
"example": "Bug Integration",
"type": "string"
},
"id": {
"description": "Entity Identifier",
"example": "BugIntegration",
"type": "string"
},
"internalType": {
"description": "Internal Type",
"enum": [
"not_unified",
"unified"
],
"example": "not_unified",
"type": "string"
},
"limit": {
"description": "Limit",
"example": 100,
"format": "int32",
"type": "integer"
},
"methods": {
"$ref": "#/definitions/Methods",
"description": "Supported Methods",
"type": "object"
},
"name": {
"description": "Name",
"example": "BugIntegration",
"type": "string"
},
"similarTo": {
"description": "Percentage to unified entity",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type",
"enum": [
"standard",
"custom"
],
"example": "standard",
"type": "string"
}
},
"type": "object"
},
"EntityItemDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"EntityItemEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Entity Item Identifier",
"example": "21312411",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"EntityItemEntityRelation": {
"properties": {
"id": {
"description": "Entity Item Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"EventDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"EventEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of the event",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Event Identifier",
"example": "21312411",
"type": "string"
},
"is_all_day": {
"description": "Is All Day",
"type": "boolean"
},
"location": {
"description": "Location",
"example": "London",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"started_at": {
"description": "Started At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Held",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Subject of the event",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"EventEntityRelation": {
"properties": {
"id": {
"description": "Event Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"EventRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/EventEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"FetchAllDescribe": {
"type": "object"
},
"FetchDescribe": {
"type": "object"
},
"FieldEntity": {
"properties": {
"arrayItem": {
"description": "Array Item",
"example": "boolean",
"type": "string"
},
"entity": {
"description": "Entity",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"description": "Format",
"example": "date",
"type": "string"
},
"id": {
"description": "Field Identifier",
"example": "21312411",
"type": "string"
},
"isEnum": {
"description": "Is Enum",
"example": true,
"type": "boolean"
},
"label": {
"description": "Label",
"example": "Custom",
"type": "string"
},
"limit": {
"description": "Limit",
"example": 100,
"format": "int32",
"type": "integer"
},
"methods": {
"$ref": "#/definitions/Methods",
"description": "Supported Methods",
"type": "object"
},
"name": {
"description": "Name",
"example": "BugIntegration",
"type": "string"
},
"relation": {
"description": "Relation",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type",
"example": "boolean",
"type": "string"
}
},
"type": "object"
},
"FieldItemDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"FieldItemEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Custom",
"type": "string"
},
"entity": {
"description": "Entity",
"example": "contact",
"type": "string"
},
"id": {
"description": "Field Item Identifier",
"example": "21312411",
"type": "string"
},
"label": {
"description": "Label",
"example": "Custom",
"type": "string"
},
"name": {
"description": "Name",
"example": "Custom",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"FieldItemEntityRelation": {
"properties": {
"id": {
"description": "Field Item Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"Header": {
"properties": {
"name": {
"description": "Name",
"type": "string"
},
"value": {
"description": "Value",
"type": "string"
}
},
"type": "object"
},
"Image": {
"properties": {
"type": {
"description": "Type",
"example": "Preview image",
"type": "string"
},
"url": {
"description": "URL",
"example": "http://google.com/images/image.png",
"type": "string"
}
},
"type": "object"
},
"InternalUserEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"email": {
"description": "Email",
"example": "bill.wall@mail.com",
"type": "string"
},
"internal_request_count": {
"description": "Internal Request Count",
"format": "int32",
"type": "integer"
},
"key": {
"description": "User Key",
"example": "21312411",
"type": "string"
},
"last_used_at": {
"description": "Last Used At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"organization": {
"description": "Organization",
"example": "M&M",
"type": "string"
},
"phone": {
"description": "Phone",
"example": "(817) 569-8900",
"type": "string"
},
"request_count": {
"description": "Request Count",
"format": "int32",
"type": "integer"
},
"roles": {
"description": "Roles",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"InternalUserEntityRelation": {
"properties": {
"key": {
"description": "User Key",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"InvoiceDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"InvoiceEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"adjustment": {
"description": "Adjustment",
"example": 4235.91,
"format": "float",
"type": "number"
},
"balance": {
"description": "Balance",
"example": 4235.91,
"format": "float",
"type": "number"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"discount": {
"description": "Discount",
"items": {
"$ref": "#/definitions/Discount"
},
"type": "array"
},
"due_date": {
"description": "Due Date",
"example": "1982-11-28",
"format": "date",
"type": "string"
},
"excise_duty": {
"description": "Excise Duty",
"example": 4235.91,
"format": "float",
"type": "number"
},
"grand_total": {
"description": "Grand Total",
"example": 4235.91,
"format": "float",
"type": "number"
},
"id": {
"description": "Invoice Identifier",
"example": "21312411",
"type": "string"
},
"invoice_date": {
"description": "Invoice Date",
"example": "1982-11-28",
"format": "date",
"type": "string"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"purchase_order": {
"description": "Purchase Order",
"example": "Order for notebook",
"type": "string"
},
"received": {
"description": "Received",
"example": 4235.91,
"format": "float",
"type": "number"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sales_commission": {
"description": "Sales Commission",
"example": 4235.91,
"format": "float",
"type": "number"
},
"shipping_and_handling": {
"description": "Shipping And Handling",
"example": 4235.91,
"format": "float",
"type": "number"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Sales",
"type": "string"
},
"subtotal": {
"description": "Subtotal",
"example": 4235.91,
"format": "float",
"type": "number"
},
"tax": {
"description": "Tax",
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"terms_and_conditions": {
"description": "Terms And Conditions",
"example": "Conditions",
"type": "string"
},
"total_price": {
"description": "Total Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"InvoiceEntityRelation": {
"properties": {
"id": {
"description": "Invoice Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"InvoiceItemDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"InvoiceItemEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"discount": {
"description": "Discount",
"items": {
"$ref": "#/definitions/Discount"
},
"type": "array"
},
"id": {
"description": "InvoiceItem Identifier",
"example": "21312411",
"type": "string"
},
"list_price": {
"description": "List Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"quantity": {
"description": "Quantity",
"example": 4235.91,
"format": "float",
"type": "number"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sales_price": {
"description": "Sales Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"subtotal": {
"description": "Subtotal",
"example": 4235.91,
"format": "float",
"type": "number"
},
"tax": {
"description": "Tax",
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"total_price": {
"description": "Total Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit",
"example": "kg",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"InvoiceItemEntityRelation": {
"properties": {
"id": {
"description": "InvoiceItem Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"InvoiceItemRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/InvoiceItemEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"InvoiceRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/InvoiceEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Item": {
"type": "object"
},
"LeadDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"LeadEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"annual_revenue": {
"description": "Annual Revenue",
"example": "100000",
"type": "string"
},
"birth_date": {
"description": "Birth Date",
"example": "1982-11-28",
"format": "date",
"type": "string"
},
"company": {
"description": "Company",
"example": "M&M",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"department": {
"description": "Department",
"example": "D2C",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of the contact",
"type": "string"
},
"do_not_call": {
"description": "Do Not Call",
"type": "boolean"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/Email"
},
"type": "array"
},
"first_name": {
"description": "First Name",
"example": "Bill",
"type": "string"
},
"id": {
"description": "Lead Identifier",
"example": "21312411",
"type": "string"
},
"industry": {
"description": "Industry",
"items": {
"type": "string"
},
"type": "array"
},
"last_name": {
"description": "Last Name",
"example": "Wall",
"type": "string"
},
"messenger": {
"description": "Messenger",
"items": {
"$ref": "#/definitions/Messenger"
},
"type": "array"
},
"middle_name": {
"description": "Middle Name",
"example": "van",
"type": "string"
},
"name_suffix": {
"description": "Name Suffix",
"example": "Jr.",
"type": "string"
},
"phone": {
"description": "Phone",
"items": {
"$ref": "#/definitions/Phone"
},
"type": "array"
},
"position": {
"description": "Position (job)",
"example": "Director of Vendor Relations",
"type": "string"
},
"rating": {
"description": "Rating",
"example": "Hot",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"salutation": {
"description": "Salutation",
"example": "Mr.",
"type": "string"
},
"source": {
"description": "Lead Source",
"type": "string"
},
"source_description": {
"description": "Lead Source Description",
"example": "Website Application",
"type": "string"
},
"status": {
"description": "Status",
"example": "Waiting for details",
"type": "string"
},
"status_description": {
"description": "Status Description",
"example": "Description",
"type": "string"
},
"type": {
"description": "Type",
"example": "Bill Wall",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"website": {
"description": "Website",
"items": {
"$ref": "#/definitions/Website"
},
"type": "array"
}
},
"type": "object"
},
"LeadEntityRelation": {
"properties": {
"id": {
"description": "Lead Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"LeadRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/LeadEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"MeetingDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"MeetingEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description of the meeting",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Meeting Identifier",
"example": "21312411",
"type": "string"
},
"location": {
"description": "Location",
"example": "Location",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"result": {
"description": "Result",
"example": "Confirmed",
"type": "string"
},
"started_at": {
"description": "Started At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Held",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "My first note",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"MeetingEntityRelation": {
"properties": {
"id": {
"description": "Meeting Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"MeetingRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/MeetingEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Messenger": {
"properties": {
"location": {
"description": "Location",
"example": "(817) 569-8900",
"type": "string"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
}
},
"type": "object"
},
"Methods": {
"type": "object"
},
"NoteDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"NoteEntity": {
"properties": {
"body": {
"description": "Body",
"example": "Body of the note",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Note Identifier",
"example": "21312411",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"subject": {
"description": "Subject",
"example": "My first note",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"NoteEntityRelation": {
"properties": {
"id": {
"description": "Note Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"NoteRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/NoteEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"OpportunityDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"OpportunityEntity": {
"properties": {
"amount": {
"description": "Amount",
"example": 4235.91,
"format": "float",
"type": "number"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"ended_at": {
"description": "Closed At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"expected_amount": {
"description": "Expected Amount",
"example": 4235.91,
"format": "float",
"type": "number"
},
"expected_end_at": {
"description": "Expected End At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Opportunity Identifier",
"example": "21312411",
"type": "string"
},
"lead_source": {
"description": "Lead Source",
"example": "Web Site",
"type": "string"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"next_step": {
"description": "Next Step",
"example": "Contact",
"type": "string"
},
"pipeline_with_stage": {
"description": "Pipeline With Stage",
"example": "Default / Contacted",
"type": "string"
},
"probability": {
"description": "Probability",
"example": 80,
"format": "int32",
"type": "integer"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"state": {
"description": "State",
"example": "Open",
"type": "string"
},
"type": {
"description": "Type",
"example": "Sales",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"OpportunityEntityRelation": {
"properties": {
"id": {
"description": "Opportunity Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"OpportunityProductDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"OpportunityProductEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"discount": {
"description": "Discount",
"items": {
"$ref": "#/definitions/Discount"
},
"type": "array"
},
"id": {
"description": "OpportunityProduct Identifier",
"example": "21312411",
"type": "string"
},
"list_price": {
"description": "List Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"quantity": {
"description": "Quantity",
"example": 4235.91,
"format": "float",
"type": "number"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sales_price": {
"description": "Sales Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"subtotal": {
"description": "Subtotal",
"example": 4235.91,
"format": "float",
"type": "number"
},
"tax": {
"description": "Tax",
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"total_price": {
"description": "Total Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit",
"example": "kg",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"OpportunityProductEntityRelation": {
"properties": {
"id": {
"description": "OpportunityProduct Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"OpportunityProductRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/OpportunityProductEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"OpportunityRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/OpportunityEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Phone": {
"properties": {
"number": {
"description": "Number",
"example": "(817) 569-8900",
"type": "string"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
}
},
"type": "object"
},
"PlatformCredential": {
"type": "object"
},
"PlatformEntity": {
"properties": {
"authorization": {
"description": "Authorization",
"items": {
"$ref": "#/definitions/Authorization"
},
"type": "array"
},
"name": {
"description": "Name",
"type": "string"
},
"resource": {
"$ref": "#/definitions/Resource",
"description": "Platform resources",
"type": "object"
},
"type": {
"description": "Type",
"type": "string"
}
},
"type": "object"
},
"PostDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"PostEntity": {
"properties": {
"body": {
"description": "Body",
"example": "My first post",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Post Identifier",
"example": "21312411",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"PostEntityRelation": {
"properties": {
"id": {
"description": "Post Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"PostRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/PostEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Price": {
"properties": {
"currency": {
"description": "Currency",
"example": "USD",
"type": "string"
},
"value": {
"description": "Value",
"example": 4235.91,
"format": "float",
"type": "number"
}
},
"type": "object"
},
"PriceBookDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"PriceBookEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"id": {
"description": "PriceBook Identifier",
"example": "21312411",
"type": "string"
},
"is_active": {
"description": "Is Active",
"example": true,
"type": "boolean"
},
"is_standard": {
"description": "Is Standard",
"example": true,
"type": "boolean"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"type": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"PriceBookEntityRelation": {
"properties": {
"id": {
"description": "PriceBook Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"PriceBookItemDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"PriceBookItemEntity": {
"properties": {
"code": {
"description": "Code",
"example": "21312411",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "PriceBookItem Identifier",
"example": "21312411",
"type": "string"
},
"is_active": {
"description": "Is Active",
"example": true,
"type": "boolean"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"price": {
"description": "Price",
"items": {
"$ref": "#/definitions/Price"
},
"type": "array"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"use_standard_price": {
"description": "Is Standard",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"PriceBookItemEntityRelation": {
"properties": {
"id": {
"description": "PriceBookItem Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"PriceBookItemRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/PriceBookItemEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"PriceBookRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/PriceBookEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"ProductDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"ProductEntity": {
"properties": {
"category": {
"description": "Category",
"items": {
"type": "string"
},
"type": "array"
},
"code": {
"description": "Code",
"example": "CM01-R",
"type": "string"
},
"cost": {
"description": "Cost",
"items": {
"$ref": "#/definitions/Cost"
},
"type": "array"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Some long description",
"type": "string"
},
"id": {
"description": "Product Identifier",
"example": "21312411",
"type": "string"
},
"image": {
"description": "Image",
"items": {
"$ref": "#/definitions/Image"
},
"type": "array"
},
"is_active": {
"description": "Is active",
"example": true,
"type": "boolean"
},
"is_taxable": {
"description": "Is taxable",
"example": true,
"type": "boolean"
},
"manufacturer": {
"description": "Manufacturer",
"example": "M&M",
"type": "string"
},
"name": {
"description": "Name",
"example": "CPU",
"type": "string"
},
"price": {
"description": "Price",
"items": {
"$ref": "#/definitions/Price"
},
"type": "array"
},
"quantity_in_demand": {
"description": "Quantity In Demand",
"example": 15.91,
"format": "float",
"type": "number"
},
"quantity_in_stock": {
"description": "Quantity In Stock",
"example": 15.91,
"format": "float",
"type": "number"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"reorder_level": {
"description": "Reorder Level",
"example": 15.91,
"format": "float",
"type": "number"
},
"sales_ended_at": {
"description": "Sales Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"sales_started_at": {
"description": "Sales Started At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"support_ended_at": {
"description": "Support Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"support_started_at": {
"description": "Support Started At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"type": {
"description": "Type",
"example": "Service",
"type": "string"
},
"unit": {
"description": "Unit",
"example": "kg",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"url": {
"description": "URL",
"example": "http://google.com/",
"type": "string"
},
"vendor": {
"description": "Vendor",
"example": "M&M",
"type": "string"
}
},
"type": "object"
},
"ProductEntityRelation": {
"properties": {
"id": {
"description": "Product Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"ProductRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/ProductEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"ProjectDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"ProjectEntity": {
"properties": {
"category": {
"description": "Category",
"example": "Software",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Body",
"example": "My first project",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Project Identifier",
"example": "21312411",
"type": "string"
},
"name": {
"description": "Name",
"example": "Bill Wall",
"type": "string"
},
"pipeline_with_stage": {
"description": "Pipeline With Stage",
"example": "Default / Contacted",
"type": "string"
},
"priority": {
"description": "Priority",
"example": "Normal",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"started_at": {
"description": "Started At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Not Started",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"ProjectEntityRelation": {
"properties": {
"id": {
"description": "Project Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"ProjectRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/ProjectEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"QuoteDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"QuoteEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"adjustment": {
"description": "Adjustment",
"example": 4235.91,
"format": "float",
"type": "number"
},
"carrier": {
"description": "Carrier",
"example": "DHL",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"currency": {
"$ref": "#/definitions/Currency",
"description": "Currency",
"type": "object"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"discount": {
"description": "Discount",
"items": {
"$ref": "#/definitions/Discount"
},
"type": "array"
},
"expiration_date": {
"description": "Expiration Date",
"example": "1982-11-28",
"format": "date",
"type": "string"
},
"grand_total": {
"description": "Grand Total",
"example": 4235.91,
"format": "float",
"type": "number"
},
"id": {
"description": "Quote Identifier",
"example": "21312411",
"type": "string"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"payment_terms": {
"description": "Payment Terms",
"example": "Net 60",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"shipping_and_handling": {
"description": "Shipping And Handling",
"example": 4235.91,
"format": "float",
"type": "number"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Sales",
"type": "string"
},
"subtotal": {
"description": "Subtotal",
"example": 4235.91,
"format": "float",
"type": "number"
},
"tax": {
"description": "Tax",
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"terms_and_conditions": {
"description": "Terms And Conditions",
"example": "Conditions",
"type": "string"
},
"total_price": {
"description": "Total Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"QuoteEntityRelation": {
"properties": {
"id": {
"description": "Quote Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"QuoteItemDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"QuoteItemEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"discount": {
"description": "Discount",
"items": {
"$ref": "#/definitions/Discount"
},
"type": "array"
},
"id": {
"description": "QuoteItem Identifier",
"example": "21312411",
"type": "string"
},
"list_price": {
"description": "List Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"quantity": {
"description": "Quantity",
"example": 4235.91,
"format": "float",
"type": "number"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"sales_price": {
"description": "Sales Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"subtotal": {
"description": "Subtotal",
"example": 4235.91,
"format": "float",
"type": "number"
},
"tax": {
"description": "Tax",
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"total_price": {
"description": "Total Price",
"example": 4235.91,
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit",
"example": "kg",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"QuoteItemEntityRelation": {
"properties": {
"id": {
"description": "QuoteItem Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"QuoteItemRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/QuoteItemEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"QuoteRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/QuoteEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Relation": {
"properties": {
"account": {
"description": "Account",
"items": {
"$ref": "#/definitions/AccountRelation"
},
"type": "array"
},
"attachment": {
"description": "Attachment",
"items": {
"$ref": "#/definitions/AttachmentRelation"
},
"type": "array"
},
"call": {
"description": "Call",
"items": {
"$ref": "#/definitions/CallRelation"
},
"type": "array"
},
"campaign": {
"description": "Campaign",
"items": {
"$ref": "#/definitions/CampaignRelation"
},
"type": "array"
},
"case": {
"description": "Case",
"items": {
"$ref": "#/definitions/CaseRelation"
},
"type": "array"
},
"comment": {
"description": "Comment",
"items": {
"$ref": "#/definitions/CommentRelation"
},
"type": "array"
},
"contact": {
"description": "Contact",
"items": {
"$ref": "#/definitions/ContactRelation"
},
"type": "array"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/EmailRelation"
},
"type": "array"
},
"event": {
"description": "Event",
"items": {
"$ref": "#/definitions/EventRelation"
},
"type": "array"
},
"invoice": {
"description": "Invoice",
"items": {
"$ref": "#/definitions/InvoiceRelation"
},
"type": "array"
},
"invoiceItem": {
"description": "Invoice Item",
"items": {
"$ref": "#/definitions/InvoiceItemRelation"
},
"type": "array"
},
"lead": {
"description": "Lead",
"items": {
"$ref": "#/definitions/LeadRelation"
},
"type": "array"
},
"meeting": {
"description": "Meeting",
"items": {
"$ref": "#/definitions/MeetingRelation"
},
"type": "array"
},
"note": {
"description": "Note",
"items": {
"$ref": "#/definitions/NoteRelation"
},
"type": "array"
},
"opportunity": {
"description": "Opportunity",
"items": {
"$ref": "#/definitions/OpportunityRelation"
},
"type": "array"
},
"opportunityProduct": {
"description": "Opportunity Product",
"items": {
"$ref": "#/definitions/OpportunityProductRelation"
},
"type": "array"
},
"post": {
"description": "Post",
"items": {
"$ref": "#/definitions/PostRelation"
},
"type": "array"
},
"priceBook": {
"description": "Price Book",
"items": {
"$ref": "#/definitions/PriceBookRelation"
},
"type": "array"
},
"priceBookItem": {
"description": "Price Book Item",
"items": {
"$ref": "#/definitions/PriceBookItemRelation"
},
"type": "array"
},
"product": {
"description": "Product",
"items": {
"$ref": "#/definitions/ProductRelation"
},
"type": "array"
},
"project": {
"description": "Project",
"items": {
"$ref": "#/definitions/ProjectRelation"
},
"type": "array"
},
"quote": {
"description": "Quote",
"items": {
"$ref": "#/definitions/QuoteRelation"
},
"type": "array"
},
"quoteItem": {
"description": "Quote Item",
"items": {
"$ref": "#/definitions/QuoteItemRelation"
},
"type": "array"
},
"tag": {
"description": "Tag",
"items": {
"$ref": "#/definitions/TagRelation"
},
"type": "array"
},
"task": {
"description": "Task",
"items": {
"$ref": "#/definitions/TaskRelation"
},
"type": "array"
},
"ticket": {
"description": "Ticket",
"items": {
"$ref": "#/definitions/TicketRelation"
},
"type": "array"
},
"user": {
"description": "User",
"items": {
"$ref": "#/definitions/UserRelation"
},
"type": "array"
}
},
"type": "object"
},
"RequestEntity": {
"properties": {
"content": {
"description": "Content (in base64 encoding)",
"type": "string"
},
"header": {
"description": "Header",
"items": {
"$ref": "#/definitions/Header"
},
"type": "array"
},
"method": {
"description": "Method",
"example": "GET",
"type": "string"
},
"path": {
"description": "Path (with query)",
"example": "contact/111/comments?count=1",
"type": "string"
}
},
"type": "object"
},
"RequestEntityRelation": {
"properties": {
"content": {
"description": "Content (in base64 encoding)",
"type": "string"
},
"header": {
"description": "Header",
"items": {
"$ref": "#/definitions/Header"
},
"type": "array"
},
"status_code": {
"description": "Status Code",
"example": 200,
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RequestsLimit": {
"properties": {
"is_exceeded": {
"description": "Is Exceeded",
"type": "boolean"
},
"retry_after": {
"description": "Retry After",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"type": {
"description": "Type",
"items": {
"$ref": "#/definitions/Type"
},
"type": "array"
}
},
"type": "object"
},
"Resource": {
"type": "object"
},
"ResultAggregate": {
"type": "object"
},
"SchemaDescribe": {
"properties": {
"create": {
"$ref": "#/definitions/CreateDescribe",
"description": "Create a resource request body schema",
"type": "object"
},
"fetch": {
"$ref": "#/definitions/FetchDescribe",
"description": "Fetch a resource response body schema",
"type": "object"
},
"fetchAll": {
"$ref": "#/definitions/FetchAllDescribe",
"description": "Fetch all or a subset of resources body response",
"type": "object"
},
"update": {
"$ref": "#/definitions/UpdateDescribe",
"description": "Update a resource request body schema",
"type": "object"
}
},
"type": "object"
},
"TagDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"TagEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "My first tag",
"type": "string"
},
"entity": {
"description": "Entity",
"enum": [
"account",
"attachment",
"call",
"campaign",
"case",
"comment",
"contact",
"email",
"event",
"invoice",
"invoiceItem",
"lead",
"meeting",
"note",
"opportunity",
"opportunityProduct",
"post",
"priceBook",
"priceBookItem",
"product",
"project",
"quote",
"quoteItem",
"tag",
"task",
"ticket",
"user"
],
"type": "string"
},
"id": {
"description": "Tag Identifier",
"example": "21312411",
"type": "string"
},
"name": {
"description": "Name",
"example": "first_tag",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"TagEntityRelation": {
"properties": {
"id": {
"description": "Tag Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"TagRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/TagEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"TaskDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"TaskEntity": {
"properties": {
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "First task",
"type": "string"
},
"due_at": {
"description": "Due At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"ended_at": {
"description": "Ended At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Task Identifier",
"example": "21312411",
"type": "string"
},
"priority": {
"description": "Priority",
"example": "Normal",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"reminder_at": {
"description": "Remainder At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"started_at": {
"description": "Started At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status",
"example": "Not Started",
"type": "string"
},
"subject": {
"description": "Name",
"example": "Title",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"TaskEntityRelation": {
"properties": {
"id": {
"description": "Task Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"TaskRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/TaskEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Tax": {
"properties": {
"percent_value": {
"description": "Percent Value",
"example": 4235.91,
"format": "float",
"type": "number"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
},
"value": {
"description": "Value",
"example": 4235.91,
"format": "float",
"type": "number"
}
},
"type": "object"
},
"TicketDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"TicketEntity": {
"properties": {
"category": {
"description": "Category",
"items": {
"type": "string"
},
"type": "array"
},
"closed_at": {
"description": "Closed At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"due_at": {
"description": "Due At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/Email"
},
"type": "array"
},
"id": {
"description": "Ticket Identifier",
"example": "21312411",
"type": "string"
},
"number": {
"description": "Number",
"example": "21312411",
"type": "string"
},
"pipeline_with_stage": {
"description": "Pipeline With Stage",
"example": "Default / Contacted",
"type": "string"
},
"priority": {
"description": "Priority",
"example": "high",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"resolution": {
"description": "Resolution",
"example": "fixed",
"type": "string"
},
"source": {
"description": "Source",
"example": "Email",
"type": "string"
},
"subject": {
"description": "Subject",
"example": "Bill Wall",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"TicketEntityRelation": {
"properties": {
"id": {
"description": "Ticket Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"TicketRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/TicketEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Type": {
"properties": {
"available": {
"description": "Available",
"example": 571,
"format": "int32",
"type": "integer"
},
"count": {
"description": "Count",
"example": 571,
"format": "float",
"type": "number"
},
"period": {
"description": "Period",
"example": 571,
"format": "int32",
"type": "integer"
},
"type": {
"description": "Type",
"example": "official",
"type": "string"
}
},
"type": "object"
},
"UpdateDescribe": {
"type": "object"
},
"UserDescribe": {
"properties": {
"entity": {
"description": "Entity",
"type": "string"
},
"schema": {
"$ref": "#/definitions/SchemaDescribe",
"description": "Schema",
"type": "object"
}
},
"type": "object"
},
"UserEntity": {
"properties": {
"address": {
"description": "Address",
"items": {
"$ref": "#/definitions/Address"
},
"type": "array"
},
"created_at": {
"description": "Created At",
"example": "2015-01-01T05:18:23-0700",
"format": "date-time",
"type": "string"
},
"department": {
"description": "Department",
"example": "Department",
"type": "string"
},
"description": {
"description": "Description",
"example": "Description",
"type": "string"
},
"email": {
"description": "Email",
"items": {
"$ref": "#/definitions/Email"
},
"type": "array"
},
"first_name": {
"description": "First Name",
"example": "Bill",
"type": "string"
},
"id": {
"description": "User Identifier",
"example": "21312411",
"type": "string"
},
"is_admin": {
"description": "Is admin",
"example": true,
"type": "boolean"
},
"is_associable": {
"description": "Is associable",
"example": true,
"type": "boolean"
},
"last_name": {
"description": "Last Name",
"example": "Wall",
"type": "string"
},
"messenger": {
"description": "Messenger",
"items": {
"$ref": "#/definitions/Messenger"
},
"type": "array"
},
"middle_name": {
"description": "Middle Name",
"example": "van",
"type": "string"
},
"name_suffix": {
"description": "Name Suffix",
"example": "Jr.",
"type": "string"
},
"phone": {
"description": "Phone",
"items": {
"$ref": "#/definitions/Phone"
},
"type": "array"
},
"position": {
"description": "Position",
"example": "Position",
"type": "string"
},
"relation": {
"$ref": "#/definitions/Relation",
"description": "Relation",
"type": "object"
},
"salutation": {
"description": "Salutation",
"example": "Mr.",
"type": "string"
},
"status": {
"description": "Status",
"example": "active",
"type": "string"
},
"updated_at": {
"description": "Updated At",
"example": "2015-02-10T17:12:23-0700",
"format": "date-time",
"type": "string"
},
"username": {
"description": "Username",
"example": "billwall777",
"type": "string"
},
"website": {
"description": "Website",
"items": {
"$ref": "#/definitions/Website"
},
"type": "array"
}
},
"type": "object"
},
"UserEntityRelation": {
"properties": {
"id": {
"description": "User Identifier",
"example": "21312411",
"type": "string"
}
},
"type": "object"
},
"UserRelation": {
"properties": {
"entity": {
"$ref": "#/definitions/UserEntityRelation",
"description": "Entity",
"type": "object"
},
"type": {
"description": "Type",
"example": "General",
"type": "string"
}
},
"type": "object"
},
"Website": {
"properties": {
"address": {
"description": "Address",
"example": "http://google.com/",
"type": "string"
},
"type": {
"description": "Type",
"example": "Work",
"type": "string"
}
},
"type": "object"
}
}
}