{ "swagger": "2.0", "info": { "version": "v1", "title": "Datto|Autotask PSA Rest API" }, "host": "webservices2.autotask.net", "basePath": "/ATServicesRest", "schemes": [ "https" ], "paths": { "/V1.0/Companies/{id}/invoiceSettings": { "get": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_Get", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountInvoiceSettingsResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_Put", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateAccountInvoiceSettingsModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{id}/invoiceSettings/contactRecipients": { "post": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_AddContactRecipients", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateContactRecipientsModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AddContactRecipientsResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{id}/invoiceSettings/contactRecipients/{contactId}": { "delete": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_DeleteContactRecipient", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "contactId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{id}/invoiceSettings/resourceRecipients": { "post": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_AddResourceRecipients", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateResourceRecipientsModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AddResourceRecipientsResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{id}/invoiceSettings/resourceRecipients/{resourceId}": { "delete": { "tags": [ "AccountInvoiceSettings" ], "operationId": "AccountInvoiceSettings_DeleteResourceRecipient", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/query": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ActionTypeModel,ActionType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ActionTypeModel,ActionType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/{id}": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ActionTypeModel,ActionType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/query/count": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes": { "put": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActionTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActionTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActionTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/entityInformation": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/entityInformation/fields": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ActionTypes/entityInformation/userDefinedFields": { "get": { "tags": [ "ActionTypes" ], "operationId": "ActionTypes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/query": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AdditionalInvoiceFieldValueModel,AdditionalInvoiceFieldValue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AdditionalInvoiceFieldValueModel,AdditionalInvoiceFieldValue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/{id}": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[AdditionalInvoiceFieldValueModel,AdditionalInvoiceFieldValue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/query/count": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/entityInformation": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/entityInformation/fields": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AdditionalInvoiceFieldValues/entityInformation/userDefinedFields": { "get": { "tags": [ "AdditionalInvoiceFieldValues" ], "operationId": "AdditionalInvoiceFieldValues_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/VersionInformation": { "get": { "tags": [ "ApiVersion" ], "operationId": "ApiVersion_ApiVersionInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ApiVersionResultModel" } } } } }, "/V1.0/Appointments/query": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AppointmentModel,Appointment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Appointments" ], "operationId": "Appointments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AppointmentModel,Appointment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments/{id}": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[AppointmentModel,Appointment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Appointments" ], "operationId": "Appointments_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments/query/count": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Appointments" ], "operationId": "Appointments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments": { "put": { "tags": [ "Appointments" ], "operationId": "Appointments_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AppointmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Appointments" ], "operationId": "Appointments_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AppointmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Appointments" ], "operationId": "Appointments_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AppointmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments/entityInformation": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments/entityInformation/fields": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Appointments/entityInformation/userDefinedFields": { "get": { "tags": [ "Appointments" ], "operationId": "Appointments_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleAttachments/entityInformation": { "get": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleAttachments/entityInformation/fields": { "get": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleAttachments/query": { "get": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleAttachments/{id}": { "get": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleAttachments/query/count": { "get": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleAttachments" ], "operationId": "ArticleAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Attachments": { "get": { "tags": [ "ArticleAttachmentsChild" ], "operationId": "ArticleAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleAttachmentsChild" ], "operationId": "ArticleAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Attachments/{id}": { "get": { "tags": [ "ArticleAttachmentsChild" ], "operationId": "ArticleAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleAttachmentsChild" ], "operationId": "ArticleAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ArticleAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/query": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/{id}": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/query/count": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/entityInformation": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleConfigurationItemCategoryAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociations" ], "operationId": "ArticleConfigurationItemCategoryAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ConfigurationItemCategoryAssociations": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleConfigurationItemCategoryAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ConfigurationItemCategoryAssociations/{id}": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ConfigurationItemCategoryAssociations/entityInformation": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ConfigurationItemCategoryAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ConfigurationItemCategoryAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleConfigurationItemCategoryAssociationsChild" ], "operationId": "ArticleConfigurationItemCategoryAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/query": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleNoteModel,ArticleNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleNoteModel,ArticleNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/{id}": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleNoteModel,ArticleNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/query/count": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/entityInformation": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/entityInformation/fields": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleNotes" ], "operationId": "ArticleNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Notes": { "get": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleNoteModel,ArticleNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Notes/{id}": { "get": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleNoteModel,ArticleNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Notes/entityInformation": { "get": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleNotesChild" ], "operationId": "ArticleNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/query": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticlePlainTextContentModel,ArticlePlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticlePlainTextContentModel,ArticlePlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/{id}": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticlePlainTextContentModel,ArticlePlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/query/count": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/entityInformation": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/entityInformation/fields": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticlePlainTextContent/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticlePlainTextContent" ], "operationId": "ArticlePlainTextContent_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/PlainTextContent": { "get": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticlePlainTextContentModel,ArticlePlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticlePlainTextContentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticlePlainTextContentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/PlainTextContent/{id}": { "get": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticlePlainTextContentModel,ArticlePlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/PlainTextContent/entityInformation": { "get": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/PlainTextContent/entityInformation/fields": { "get": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/PlainTextContent/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticlePlainTextContentChild" ], "operationId": "ArticlePlainTextContentChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/query": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTagAssociationModel,ArticleTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTagAssociationModel,ArticleTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/{id}": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleTagAssociationModel,ArticleTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/query/count": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/entityInformation": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleTagAssociations" ], "operationId": "ArticleTagAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TagAssociations": { "get": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTagAssociationModel,ArticleTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleTagAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TagAssociations/{id}": { "get": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleTagAssociationModel,ArticleTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TagAssociations/entityInformation": { "get": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TagAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleTagAssociationsChild" ], "operationId": "ArticleTagAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/query": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTicketAssociationModel,ArticleTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTicketAssociationModel,ArticleTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/{id}": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleTicketAssociationModel,ArticleTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/query/count": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/entityInformation": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleTicketAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleTicketAssociations" ], "operationId": "ArticleTicketAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TicketAssociations": { "get": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleTicketAssociationModel,ArticleTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleTicketAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TicketAssociations/{id}": { "get": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleTicketAssociationModel,ArticleTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TicketAssociations/entityInformation": { "get": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TicketAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/TicketAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleTicketAssociationsChild" ], "operationId": "ArticleTicketAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/query": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToArticleAssociationModel,ArticleToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToArticleAssociationModel,ArticleToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/{id}": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleToArticleAssociationModel,ArticleToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/query/count": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/entityInformation": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToArticleAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleToArticleAssociations" ], "operationId": "ArticleToArticleAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ArticleAssociations": { "get": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToArticleAssociationModel,ArticleToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleToArticleAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ArticleAssociations/{id}": { "get": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleToArticleAssociationModel,ArticleToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ArticleAssociations/entityInformation": { "get": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ArticleAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/ArticleAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleToArticleAssociationsChild" ], "operationId": "ArticleToArticleAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/query": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/{id}": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/query/count": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/entityInformation": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ArticleToDocumentAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleToDocumentAssociations" ], "operationId": "ArticleToDocumentAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/DocumentAssociations": { "get": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ArticleToDocumentAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/DocumentAssociations/{id}": { "get": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/DocumentAssociations/entityInformation": { "get": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/DocumentAssociations/entityInformation/fields": { "get": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{parentId}/DocumentAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ArticleToDocumentAssociationsChild" ], "operationId": "ArticleToDocumentAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/query": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AttachmentInfoModel,AttachmentInfo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[AttachmentInfoModel,AttachmentInfo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/{id}": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[AttachmentInfoModel,AttachmentInfo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/query/count": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/entityInformation": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/entityInformation/fields": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/AttachmentInfo/entityInformation/userDefinedFields": { "get": { "tags": [ "AttachmentInfo" ], "operationId": "AttachmentInfo_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Authenticate": { "get": { "tags": [ "AuthenticateApiIntegration" ], "operationId": "AuthenticateApiIntegration_QueryAuthenticate", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AuthTokenResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Version": { "get": { "tags": [ "AutotaskVersionApiIntegration" ], "operationId": "AutotaskVersionApiIntegration_QueryVersionInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AutotaskVersionResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/query": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingCodeModel,AllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingCodeModel,AllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/{id}": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[BillingCodeModel,AllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/query/count": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/entityInformation": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/entityInformation/fields": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingCodes/entityInformation/userDefinedFields": { "get": { "tags": [ "BillingCodes" ], "operationId": "BillingCodes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/query": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingItemApprovalLevelModel,BillingItemApprovalLevel]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingItemApprovalLevelModel,BillingItemApprovalLevel]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/{id}": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[BillingItemApprovalLevelModel,BillingItemApprovalLevel]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/query/count": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels": { "post": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingItemApprovalLevelModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/entityInformation": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/entityInformation/fields": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItemApprovalLevels/entityInformation/userDefinedFields": { "get": { "tags": [ "BillingItemApprovalLevels" ], "operationId": "BillingItemApprovalLevels_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/query": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingItemModel,BillingItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingItems" ], "operationId": "BillingItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[BillingItemModel,BillingItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/{id}": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[BillingItemModel,BillingItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/query/count": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "BillingItems" ], "operationId": "BillingItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems": { "put": { "tags": [ "BillingItems" ], "operationId": "BillingItems_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "BillingItems" ], "operationId": "BillingItems_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BillingItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/entityInformation": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/entityInformation/fields": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/BillingItems/entityInformation/userDefinedFields": { "get": { "tags": [ "BillingItems" ], "operationId": "BillingItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/query": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChangeOrderChargeModel,ChangeOrderCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChangeOrderChargeModel,ChangeOrderCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/{id}": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ChangeOrderChargeModel,ChangeOrderCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/query/count": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges": { "put": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChangeOrderChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChangeOrderChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChangeOrderChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/entityInformation": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/entityInformation/fields": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeOrderCharges/entityInformation/userDefinedFields": { "get": { "tags": [ "ChangeOrderCharges" ], "operationId": "ChangeOrderCharges_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/query": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChangeRequestLinkModel,ChangeRequestLink]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChangeRequestLinkModel,ChangeRequestLink]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/{id}": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ChangeRequestLinkModel,ChangeRequestLink]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/query/count": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks": { "post": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChangeRequestLinkModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/entityInformation": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/entityInformation/fields": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChangeRequestLinks/entityInformation/userDefinedFields": { "get": { "tags": [ "ChangeRequestLinks" ], "operationId": "ChangeRequestLinks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/query": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChecklistLibraryModel,ChecklistLibrary]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChecklistLibraryModel,ChecklistLibrary]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{id}": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ChecklistLibraryModel,ChecklistLibrary]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/query/count": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries": { "put": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/entityInformation": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/entityInformation/fields": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/entityInformation/userDefinedFields": { "get": { "tags": [ "ChecklistLibraries" ], "operationId": "ChecklistLibraries_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/query": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/{id}": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/query/count": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/entityInformation": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/entityInformation/fields": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraryChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ChecklistLibraryChecklistItems" ], "operationId": "ChecklistLibraryChecklistItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{parentId}/ChecklistItems": { "get": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ChecklistLibraryChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{parentId}/ChecklistItems/{id}": { "get": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{parentId}/ChecklistItems/entityInformation": { "get": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{parentId}/ChecklistItems/entityInformation/fields": { "get": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ChecklistLibraries/{parentId}/ChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ChecklistLibraryChecklistItemsChild" ], "operationId": "ChecklistLibraryChecklistItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/query": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ClassificationIconModel,ClassificationIcon]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ClassificationIconModel,ClassificationIcon]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/{id}": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ClassificationIconModel,ClassificationIcon]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/query/count": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/entityInformation": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/entityInformation/fields": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClassificationIcons/entityInformation/userDefinedFields": { "get": { "tags": [ "ClassificationIcons" ], "operationId": "ClassificationIcons_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/query": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ClientPortalUserModel,ClientPortalUser]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ClientPortalUserModel,ClientPortalUser]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/{id}": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ClientPortalUserModel,ClientPortalUser]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/query/count": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers": { "put": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ClientPortalUserModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ClientPortalUserModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ClientPortalUserModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/entityInformation": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/entityInformation/fields": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ClientPortalUsers/entityInformation/userDefinedFields": { "get": { "tags": [ "ClientPortalUsers" ], "operationId": "ClientPortalUsers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/query": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ComanagedAssociationModel,ComanagedAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ComanagedAssociationModel,ComanagedAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/{id}": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ComanagedAssociationModel,ComanagedAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/query/count": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations": { "put": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ComanagedAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ComanagedAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ComanagedAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/entityInformation": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/entityInformation/fields": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ComanagedAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ComanagedAssociations" ], "operationId": "ComanagedAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/query": { "get": { "tags": [ "Companies" ], "operationId": "Companies_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyModel,Account]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Companies" ], "operationId": "Companies_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyModel,Account]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{id}": { "get": { "tags": [ "Companies" ], "operationId": "Companies_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyModel,Account]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/query/count": { "get": { "tags": [ "Companies" ], "operationId": "Companies_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Companies" ], "operationId": "Companies_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies": { "put": { "tags": [ "Companies" ], "operationId": "Companies_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Companies" ], "operationId": "Companies_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Companies" ], "operationId": "Companies_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/entityInformation": { "get": { "tags": [ "Companies" ], "operationId": "Companies_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/entityInformation/fields": { "get": { "tags": [ "Companies" ], "operationId": "Companies_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/entityInformation/userDefinedFields": { "get": { "tags": [ "Companies" ], "operationId": "Companies_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/query": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyAlertModel,AccountAlert]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyAlertModel,AccountAlert]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/{id}": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyAlertModel,AccountAlert]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/query/count": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/entityInformation": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/entityInformation/fields": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAlerts/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyAlerts" ], "operationId": "CompanyAlerts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Alerts": { "get": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyAlertModel,AccountAlert]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyAlertModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyAlertModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyAlertModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Alerts/{id}": { "get": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyAlertModel,AccountAlert]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Alerts/entityInformation": { "get": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Alerts/entityInformation/fields": { "get": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Alerts/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyAlertsChild" ], "operationId": "CompanyAlertsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAttachments/entityInformation": { "get": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAttachments/entityInformation/fields": { "get": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAttachments/query": { "get": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAttachments/{id}": { "get": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyAttachments/query/count": { "get": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAttachments" ], "operationId": "CompanyAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Attachments": { "get": { "tags": [ "CompanyAttachmentsChild" ], "operationId": "CompanyAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyAttachmentsChild" ], "operationId": "CompanyAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Attachments/{id}": { "get": { "tags": [ "CompanyAttachmentsChild" ], "operationId": "CompanyAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyAttachmentsChild" ], "operationId": "CompanyAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/query": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyCategoryModel,AccountCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyCategoryModel,AccountCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/{id}": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyCategoryModel,AccountCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/query/count": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories": { "put": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/entityInformation": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/entityInformation/fields": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyCategories" ], "operationId": "CompanyCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Contacts": { "get": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactModel,Contact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Contacts/{id}": { "get": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactModel,Contact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Contacts/entityInformation": { "get": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Contacts/entityInformation/fields": { "get": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Contacts/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyContactsChild" ], "operationId": "CompanyContactsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/query": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyLocationModel,AccountPhysicalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyLocationModel,AccountPhysicalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/{id}": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/query/count": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/entityInformation": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/entityInformation/fields": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyLocations/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyLocations" ], "operationId": "CompanyLocations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Locations": { "get": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyLocationModel,AccountPhysicalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Locations/{id}": { "get": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Locations/entityInformation": { "get": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Locations/entityInformation/fields": { "get": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Locations/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyLocationsChild" ], "operationId": "CompanyLocationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNoteAttachments/entityInformation": { "get": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNoteAttachments/entityInformation/fields": { "get": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNoteAttachments/query": { "get": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNoteAttachments/{id}": { "get": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNoteAttachments/query/count": { "get": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNoteAttachments" ], "operationId": "CompanyNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/{parentId}/Attachments": { "get": { "tags": [ "CompanyNoteAttachmentsChild" ], "operationId": "CompanyNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNoteAttachmentsChild" ], "operationId": "CompanyNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "CompanyNoteAttachmentsChild" ], "operationId": "CompanyNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyNoteAttachmentsChild" ], "operationId": "CompanyNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/query": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyNoteModel,AccountNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyNoteModel,AccountNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/{id}": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyNoteModel,AccountNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/query/count": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/entityInformation": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/entityInformation/fields": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyNotes" ], "operationId": "CompanyNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Notes": { "get": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyNoteModel,AccountNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Notes/{id}": { "get": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyNoteModel,AccountNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Notes/entityInformation": { "get": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyNotesChild" ], "operationId": "CompanyNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/query": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanySiteConfigurationModel,AccountLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanySiteConfigurationModel,AccountLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/{id}": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanySiteConfigurationModel,AccountLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/query/count": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/entityInformation": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/entityInformation/fields": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanySiteConfigurations/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanySiteConfigurations" ], "operationId": "CompanySiteConfigurations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/SiteConfigurations": { "get": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanySiteConfigurationModel,AccountLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanySiteConfigurationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanySiteConfigurationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/SiteConfigurations/{id}": { "get": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanySiteConfigurationModel,AccountLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/SiteConfigurations/entityInformation": { "get": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/SiteConfigurations/entityInformation/fields": { "get": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/SiteConfigurations/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanySiteConfigurationsChild" ], "operationId": "CompanySiteConfigurationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/query": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyTeamModel,AccountTeam]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyTeamModel,AccountTeam]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/{id}": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyTeamModel,AccountTeam]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/query/count": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/entityInformation": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/entityInformation/fields": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyTeams/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyTeams" ], "operationId": "CompanyTeams_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Teams": { "get": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyTeamModel,AccountTeam]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyTeamModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Teams/{id}": { "get": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyTeamModel,AccountTeam]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Teams/entityInformation": { "get": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Teams/entityInformation/fields": { "get": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/Teams/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyTeamsChild" ], "operationId": "CompanyTeamsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/query": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyToDoModel,AccountToDo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyToDoModel,AccountToDo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/{id}": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyToDoModel,AccountToDo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/query/count": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/entityInformation": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/entityInformation/fields": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyToDos/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyToDos" ], "operationId": "CompanyToDos_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/ToDos": { "get": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyToDoModel,AccountToDo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyToDoModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyToDoModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyToDoModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/ToDos/{id}": { "get": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyToDoModel,AccountToDo]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/ToDos/entityInformation": { "get": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/ToDos/entityInformation/fields": { "get": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Companies/{parentId}/ToDos/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyToDosChild" ], "operationId": "CompanyToDosChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/query": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/{id}": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/query/count": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/entityInformation": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookExcludedResources" ], "operationId": "CompanyWebhookExcludedResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/ExcludedResources": { "get": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookExcludedResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/ExcludedResources/{id}": { "get": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/ExcludedResources/entityInformation": { "get": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/ExcludedResources/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/ExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookExcludedResourcesChild" ], "operationId": "CompanyWebhookExcludedResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/query": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookFieldModel,AccountWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookFieldModel,AccountWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/{id}": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookFieldModel,AccountWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/query/count": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/entityInformation": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookFields/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookFields" ], "operationId": "CompanyWebhookFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/Fields": { "get": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookFieldModel,AccountWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/Fields/{id}": { "get": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookFieldModel,AccountWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/Fields/entityInformation": { "get": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/Fields/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/Fields/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookFieldsChild" ], "operationId": "CompanyWebhookFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/query": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookModel,AccountWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookModel,AccountWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{id}": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookModel,AccountWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/query/count": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks": { "put": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/entityInformation": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/entityInformation/fields": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhooks" ], "operationId": "CompanyWebhooks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/query": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/{id}": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/query/count": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/entityInformation": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhookUdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookUdfFields" ], "operationId": "CompanyWebhookUdfFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/UdfFields": { "get": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CompanyWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/UdfFields/{id}": { "get": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/UdfFields/entityInformation": { "get": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/UdfFields/entityInformation/fields": { "get": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/CompanyWebhooks/{parentId}/UdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "CompanyWebhookUdfFieldsChild" ], "operationId": "CompanyWebhookUdfFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemAttachments/entityInformation": { "get": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemAttachments/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemAttachments/query": { "get": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemAttachments/{id}": { "get": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemAttachments/query/count": { "get": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemAttachments" ], "operationId": "ConfigurationItemAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Attachments": { "get": { "tags": [ "ConfigurationItemAttachmentsChild" ], "operationId": "ConfigurationItemAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemAttachmentsChild" ], "operationId": "ConfigurationItemAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Attachments/{id}": { "get": { "tags": [ "ConfigurationItemAttachmentsChild" ], "operationId": "ConfigurationItemAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemAttachmentsChild" ], "operationId": "ConfigurationItemAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/query": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/{id}": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/query/count": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/entityInformation": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemBillingProductAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemBillingProductAssociations" ], "operationId": "ConfigurationItemBillingProductAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/BillingProductAssociations": { "get": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/{id}": { "get": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/entityInformation": { "get": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemBillingProductAssociationsChild" ], "operationId": "ConfigurationItemBillingProductAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/query": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemCategoryModel,InstalledProductCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemCategoryModel,InstalledProductCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{id}": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemCategoryModel,InstalledProductCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/query/count": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories": { "put": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/entityInformation": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemCategories" ], "operationId": "ConfigurationItemCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/query": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/{id}": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/query/count": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/entityInformation": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategoryUdfAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociations" ], "operationId": "ConfigurationItemCategoryUdfAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{parentId}/UdfAssociations": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryUdfAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryUdfAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemCategoryUdfAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{parentId}/UdfAssociations/{id}": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{parentId}/UdfAssociations/entityInformation": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{parentId}/UdfAssociations/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemCategories/{parentId}/UdfAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemCategoryUdfAssociationsChild" ], "operationId": "ConfigurationItemCategoryUdfAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/query": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/{id}": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/query/count": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/entityInformation": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemDnsRecords/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemDnsRecords" ], "operationId": "ConfigurationItemDnsRecords_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/DnsRecords": { "get": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/DnsRecords/{id}": { "get": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/DnsRecords/entityInformation": { "get": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/DnsRecords/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/DnsRecords/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemDnsRecordsChild" ], "operationId": "ConfigurationItemDnsRecordsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNoteAttachments/entityInformation": { "get": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNoteAttachments/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNoteAttachments/query": { "get": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNoteAttachments/{id}": { "get": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNoteAttachments/query/count": { "get": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNoteAttachments" ], "operationId": "ConfigurationItemNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/{parentId}/Attachments": { "get": { "tags": [ "ConfigurationItemNoteAttachmentsChild" ], "operationId": "ConfigurationItemNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNoteAttachmentsChild" ], "operationId": "ConfigurationItemNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "ConfigurationItemNoteAttachmentsChild" ], "operationId": "ConfigurationItemNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemNoteAttachmentsChild" ], "operationId": "ConfigurationItemNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/query": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemNoteModel,InstalledProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemNoteModel,InstalledProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/{id}": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemNoteModel,InstalledProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/query/count": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/entityInformation": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemNotes" ], "operationId": "ConfigurationItemNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Notes": { "get": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemNoteModel,InstalledProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Notes/{id}": { "get": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemNoteModel,InstalledProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Notes/entityInformation": { "get": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemNotesChild" ], "operationId": "ConfigurationItemNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/query": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/{id}": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/query/count": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/entityInformation": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemRelatedItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemRelatedItems" ], "operationId": "ConfigurationItemRelatedItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/RelatedItems": { "get": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemRelatedItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/RelatedItems/{id}": { "get": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/RelatedItems/entityInformation": { "get": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/RelatedItems/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/RelatedItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemRelatedItemsChild" ], "operationId": "ConfigurationItemRelatedItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/query": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemModel,InstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemModel,InstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{id}": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemModel,InstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/query/count": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems": { "put": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/entityInformation": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/entityInformation/fields": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItems" ], "operationId": "ConfigurationItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/query": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/{id}": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/query/count": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/entityInformation": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemSslSubjectAlternativeNames/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNames" ], "operationId": "ConfigurationItemSslSubjectAlternativeNames_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/SslSubjectAlternativeNames": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/SslSubjectAlternativeNames/{id}": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/SslSubjectAlternativeNames/entityInformation": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/SslSubjectAlternativeNames/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItems/{parentId}/SslSubjectAlternativeNames/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemSslSubjectAlternativeNamesChild" ], "operationId": "ConfigurationItemSslSubjectAlternativeNamesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/query": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemTypeModel,InstalledProductType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemTypeModel,InstalledProductType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/{id}": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemTypeModel,InstalledProductType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/query/count": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes": { "put": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/entityInformation": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemTypes/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemTypes" ], "operationId": "ConfigurationItemTypes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/query": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/{id}": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/query/count": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResources" ], "operationId": "ConfigurationItemWebhookExcludedResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/ExcludedResources": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookExcludedResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/ExcludedResources/{id}": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/ExcludedResources/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/ExcludedResources/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/ExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookExcludedResourcesChild" ], "operationId": "ConfigurationItemWebhookExcludedResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/query": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/{id}": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/query/count": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookFields" ], "operationId": "ConfigurationItemWebhookFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/Fields": { "get": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/Fields/{id}": { "get": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/Fields/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/Fields/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/Fields/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookFieldsChild" ], "operationId": "ConfigurationItemWebhookFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/query": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookModel,InstalledProductWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookModel,InstalledProductWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{id}": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookModel,InstalledProductWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/query/count": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks": { "put": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhooks" ], "operationId": "ConfigurationItemWebhooks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/query": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/{id}": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/query/count": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhookUdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookUdfFields" ], "operationId": "ConfigurationItemWebhookUdfFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/UdfFields": { "get": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/UdfFields/{id}": { "get": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/UdfFields/entityInformation": { "get": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/UdfFields/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemWebhooks/{parentId}/UdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemWebhookUdfFieldsChild" ], "operationId": "ConfigurationItemWebhookUdfFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/query": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactBillingProductAssociationModel,ContactBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactBillingProductAssociationModel,ContactBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/{id}": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactBillingProductAssociationModel,ContactBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/query/count": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/entityInformation": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/entityInformation/fields": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactBillingProductAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactBillingProductAssociations" ], "operationId": "ContactBillingProductAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{parentId}/BillingProductAssociations": { "get": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactBillingProductAssociationModel,ContactBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactBillingProductAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{parentId}/BillingProductAssociations/{id}": { "get": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactBillingProductAssociationModel,ContactBillingProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{parentId}/BillingProductAssociations/entityInformation": { "get": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{parentId}/BillingProductAssociations/entityInformation/fields": { "get": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{parentId}/BillingProductAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactBillingProductAssociationsChild" ], "operationId": "ContactBillingProductAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/query": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactGroupContactModel,ContactGroupContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactGroupContactModel,ContactGroupContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/{id}": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactGroupContactModel,ContactGroupContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/query/count": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/entityInformation": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/entityInformation/fields": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroupContacts/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactGroupContacts" ], "operationId": "ContactGroupContacts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{parentId}/Contacts": { "get": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactGroupContactModel,ContactGroupContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactGroupContactModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{parentId}/Contacts/{id}": { "get": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactGroupContactModel,ContactGroupContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{parentId}/Contacts/entityInformation": { "get": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{parentId}/Contacts/entityInformation/fields": { "get": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{parentId}/Contacts/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactGroupContactsChild" ], "operationId": "ContactGroupContactsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/query": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactGroupModel,ContactGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactGroupModel,ContactGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/{id}": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactGroupModel,ContactGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/query/count": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups": { "put": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/entityInformation": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/entityInformation/fields": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactGroups/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactGroups" ], "operationId": "ContactGroups_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/query": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactModel,Contact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Contacts" ], "operationId": "Contacts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactModel,Contact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/{id}": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactModel,Contact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/query/count": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Contacts" ], "operationId": "Contacts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/entityInformation": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/entityInformation/fields": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contacts/entityInformation/userDefinedFields": { "get": { "tags": [ "Contacts" ], "operationId": "Contacts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/query": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/{id}": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/query/count": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/entityInformation": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/entityInformation/fields": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookExcludedResources" ], "operationId": "ContactWebhookExcludedResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/ExcludedResources": { "get": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookExcludedResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/ExcludedResources/{id}": { "get": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/ExcludedResources/entityInformation": { "get": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/ExcludedResources/entityInformation/fields": { "get": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/ExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookExcludedResourcesChild" ], "operationId": "ContactWebhookExcludedResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/query": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookFieldModel,ContactWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookFieldModel,ContactWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/{id}": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookFieldModel,ContactWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/query/count": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/entityInformation": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/entityInformation/fields": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookFields" ], "operationId": "ContactWebhookFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/Fields": { "get": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookFieldModel,ContactWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/Fields/{id}": { "get": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookFieldModel,ContactWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/Fields/entityInformation": { "get": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/Fields/entityInformation/fields": { "get": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/Fields/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookFieldsChild" ], "operationId": "ContactWebhookFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/query": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookModel,ContactWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookModel,ContactWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{id}": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookModel,ContactWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/query/count": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks": { "put": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/entityInformation": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/entityInformation/fields": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhooks" ], "operationId": "ContactWebhooks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/query": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookUdfFieldModel,ContactWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookUdfFieldModel,ContactWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/{id}": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookUdfFieldModel,ContactWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/query/count": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/entityInformation": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/entityInformation/fields": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhookUdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookUdfFields" ], "operationId": "ContactWebhookUdfFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/UdfFields": { "get": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContactWebhookUdfFieldModel,ContactWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/UdfFields/{id}": { "get": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContactWebhookUdfFieldModel,ContactWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/UdfFields/entityInformation": { "get": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/UdfFields/entityInformation/fields": { "get": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContactWebhooks/{parentId}/UdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "ContactWebhookUdfFieldsChild" ], "operationId": "ContactWebhookUdfFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/query": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBillingRuleModel,ContractBillingRule]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBillingRuleModel,ContractBillingRule]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/{id}": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBillingRuleModel,ContractBillingRule]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/query/count": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/entityInformation": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/entityInformation/fields": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBillingRules/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBillingRules" ], "operationId": "ContractBillingRules_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BillingRules": { "get": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBillingRuleModel,ContractBillingRule]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBillingRuleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBillingRuleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBillingRuleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BillingRules/{id}": { "get": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBillingRuleModel,ContractBillingRule]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BillingRules/entityInformation": { "get": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BillingRules/entityInformation/fields": { "get": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BillingRules/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBillingRulesChild" ], "operationId": "ContractBillingRulesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/query": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockHourFactorModel,ContractFactor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockHourFactorModel,ContractFactor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/{id}": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBlockHourFactorModel,ContractFactor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/query/count": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/entityInformation": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/entityInformation/fields": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlockHourFactors/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBlockHourFactors" ], "operationId": "ContractBlockHourFactors_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BlockHourFactors": { "get": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockHourFactorModel,ContractFactor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockHourFactorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockHourFactorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockHourFactorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BlockHourFactors/{id}": { "get": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBlockHourFactorModel,ContractFactor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BlockHourFactors/entityInformation": { "get": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BlockHourFactors/entityInformation/fields": { "get": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/BlockHourFactors/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBlockHourFactorsChild" ], "operationId": "ContractBlockHourFactorsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/query": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockModel,ContractBlock]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockModel,ContractBlock]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/{id}": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBlockModel,ContractBlock]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/query/count": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/entityInformation": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/entityInformation/fields": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractBlocks/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBlocks" ], "operationId": "ContractBlocks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Blocks": { "get": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractBlockModel,ContractBlock]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractBlockModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Blocks/{id}": { "get": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractBlockModel,ContractBlock]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Blocks/entityInformation": { "get": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Blocks/entityInformation/fields": { "get": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Blocks/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractBlocksChild" ], "operationId": "ContractBlocksChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/query": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractChargeModel,ContractCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractChargeModel,ContractCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/{id}": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractChargeModel,ContractCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/query/count": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/entityInformation": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/entityInformation/fields": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractCharges/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractCharges" ], "operationId": "ContractCharges_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Charges": { "get": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractChargeModel,ContractCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Charges/{id}": { "get": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractChargeModel,ContractCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Charges/entityInformation": { "get": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Charges/entityInformation/fields": { "get": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Charges/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractChargesChild" ], "operationId": "ContractChargesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/query": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/{id}": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/query/count": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/entityInformation": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/entityInformation/fields": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionBillingCodes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionBillingCodes" ], "operationId": "ContractExclusionBillingCodes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionBillingCodes": { "get": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionBillingCodeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionBillingCodes/{id}": { "get": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionBillingCodes/entityInformation": { "get": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionBillingCodes/entityInformation/fields": { "get": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionBillingCodes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionBillingCodesChild" ], "operationId": "ContractExclusionBillingCodesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/query": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionRoleModel,ContractExclusionRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionRoleModel,ContractExclusionRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/{id}": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionRoleModel,ContractExclusionRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/query/count": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/entityInformation": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/entityInformation/fields": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionRoles" ], "operationId": "ContractExclusionRoles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionRoles": { "get": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionRoleModel,ContractExclusionRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionRoles/{id}": { "get": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionRoleModel,ContractExclusionRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionRoles/entityInformation": { "get": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionRoles/entityInformation/fields": { "get": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ExclusionRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionRolesChild" ], "operationId": "ContractExclusionRolesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/query": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/{id}": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/query/count": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/entityInformation": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/entityInformation/fields": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionSetExcludedRoles" ], "operationId": "ContractExclusionSetExcludedRoles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedRoles": { "get": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionSetExcludedRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedRoles/{id}": { "get": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedRoles/entityInformation": { "get": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedRoles/entityInformation/fields": { "get": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionSetExcludedRolesChild" ], "operationId": "ContractExclusionSetExcludedRolesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/query": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/{id}": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/query/count": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/entityInformation": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/entityInformation/fields": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSetExcludedWorkTypes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypes" ], "operationId": "ContractExclusionSetExcludedWorkTypes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedWorkTypes": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionSetExcludedWorkTypeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedWorkTypes/{id}": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedWorkTypes/entityInformation": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedWorkTypes/entityInformation/fields": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{parentId}/ExcludedWorkTypes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionSetExcludedWorkTypesChild" ], "operationId": "ContractExclusionSetExcludedWorkTypesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/query": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetModel,ContractExclusionSet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractExclusionSetModel,ContractExclusionSet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/{id}": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractExclusionSetModel,ContractExclusionSet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/query/count": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets": { "put": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionSetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionSetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractExclusionSetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/entityInformation": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/entityInformation/fields": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractExclusionSets/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractExclusionSets" ], "operationId": "ContractExclusionSets_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/query": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractMilestoneModel,ContractMilestone]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractMilestoneModel,ContractMilestone]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/{id}": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractMilestoneModel,ContractMilestone]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/query/count": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/entityInformation": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/entityInformation/fields": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractMilestones/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractMilestones" ], "operationId": "ContractMilestones_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Milestones": { "get": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractMilestoneModel,ContractMilestone]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractMilestoneModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractMilestoneModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractMilestoneModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Milestones/{id}": { "get": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractMilestoneModel,ContractMilestone]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Milestones/entityInformation": { "get": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Milestones/entityInformation/fields": { "get": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Milestones/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractMilestonesChild" ], "operationId": "ContractMilestonesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNoteAttachments/entityInformation": { "get": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNoteAttachments/entityInformation/fields": { "get": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNoteAttachments/query": { "get": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNoteAttachments/{id}": { "get": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNoteAttachments/query/count": { "get": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNoteAttachments" ], "operationId": "ContractNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/{parentId}/Attachments": { "get": { "tags": [ "ContractNoteAttachmentsChild" ], "operationId": "ContractNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNoteAttachmentsChild" ], "operationId": "ContractNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "ContractNoteAttachmentsChild" ], "operationId": "ContractNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ContractNoteAttachmentsChild" ], "operationId": "ContractNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContractNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/query": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractNoteModel,ContractNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractNoteModel,ContractNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/{id}": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractNoteModel,ContractNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/query/count": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/entityInformation": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/entityInformation/fields": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractNotes" ], "operationId": "ContractNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Notes": { "get": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractNoteModel,ContractNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Notes/{id}": { "get": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractNoteModel,ContractNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Notes/entityInformation": { "get": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractNotesChild" ], "operationId": "ContractNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/query": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRateModel,ContractRate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRates" ], "operationId": "ContractRates_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRateModel,ContractRate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/{id}": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRateModel,ContractRate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/query/count": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRates" ], "operationId": "ContractRates_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/entityInformation": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/entityInformation/fields": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRates/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRates" ], "operationId": "ContractRates_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Rates": { "get": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRateModel,ContractRate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRateModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRateModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRateModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Rates/{id}": { "get": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRateModel,ContractRate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Rates/entityInformation": { "get": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Rates/entityInformation/fields": { "get": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Rates/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRatesChild" ], "operationId": "ContractRatesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/query": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRetainerModel,ContractRetainer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRetainerModel,ContractRetainer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/{id}": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRetainerModel,ContractRetainer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/query/count": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/entityInformation": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/entityInformation/fields": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRetainers/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRetainers" ], "operationId": "ContractRetainers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Retainers": { "get": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRetainerModel,ContractRetainer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRetainerModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRetainerModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRetainerModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Retainers/{id}": { "get": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRetainerModel,ContractRetainer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Retainers/entityInformation": { "get": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Retainers/entityInformation/fields": { "get": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Retainers/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRetainersChild" ], "operationId": "ContractRetainersChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/query": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRoleCostModel,ContractRoleCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRoleCostModel,ContractRoleCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/{id}": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRoleCostModel,ContractRoleCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/query/count": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/entityInformation": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/entityInformation/fields": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractRoleCosts/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRoleCosts" ], "operationId": "ContractRoleCosts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/RoleCosts": { "get": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractRoleCostModel,ContractRoleCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRoleCostModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRoleCostModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractRoleCostModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/RoleCosts/{id}": { "get": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractRoleCostModel,ContractRoleCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/RoleCosts/entityInformation": { "get": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/RoleCosts/entityInformation/fields": { "get": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/RoleCosts/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractRoleCostsChild" ], "operationId": "ContractRoleCostsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/query": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractModel,Contract]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Contracts" ], "operationId": "Contracts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractModel,Contract]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{id}": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractModel,Contract]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/query/count": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Contracts" ], "operationId": "Contracts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts": { "put": { "tags": [ "Contracts" ], "operationId": "Contracts_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Contracts" ], "operationId": "Contracts_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Contracts" ], "operationId": "Contracts_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/entityInformation": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/entityInformation/fields": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/entityInformation/userDefinedFields": { "get": { "tags": [ "Contracts" ], "operationId": "Contracts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceAdjustments": { "post": { "tags": [ "ContractServiceAdjustments" ], "operationId": "ContractServiceAdjustments_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceAdjustmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceAdjustments/entityInformation": { "get": { "tags": [ "ContractServiceAdjustments" ], "operationId": "ContractServiceAdjustments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceAdjustments/entityInformation/fields": { "get": { "tags": [ "ContractServiceAdjustments" ], "operationId": "ContractServiceAdjustments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceAdjustments/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceAdjustments" ], "operationId": "ContractServiceAdjustments_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceAdjustments": { "post": { "tags": [ "ContractServiceAdjustmentsChild" ], "operationId": "ContractServiceAdjustmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceAdjustmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceAdjustments/entityInformation": { "get": { "tags": [ "ContractServiceAdjustmentsChild" ], "operationId": "ContractServiceAdjustmentsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceAdjustments/entityInformation/fields": { "get": { "tags": [ "ContractServiceAdjustmentsChild" ], "operationId": "ContractServiceAdjustmentsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceAdjustments/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceAdjustmentsChild" ], "operationId": "ContractServiceAdjustmentsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleAdjustments": { "post": { "tags": [ "ContractServiceBundleAdjustments" ], "operationId": "ContractServiceBundleAdjustments_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceBundleAdjustmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleAdjustments/entityInformation": { "get": { "tags": [ "ContractServiceBundleAdjustments" ], "operationId": "ContractServiceBundleAdjustments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleAdjustments/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundleAdjustments" ], "operationId": "ContractServiceBundleAdjustments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleAdjustments/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundleAdjustments" ], "operationId": "ContractServiceBundleAdjustments_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleAdjustments": { "post": { "tags": [ "ContractServiceBundleAdjustmentsChild" ], "operationId": "ContractServiceBundleAdjustmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceBundleAdjustmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleAdjustments/entityInformation": { "get": { "tags": [ "ContractServiceBundleAdjustmentsChild" ], "operationId": "ContractServiceBundleAdjustmentsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleAdjustments/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundleAdjustmentsChild" ], "operationId": "ContractServiceBundleAdjustmentsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleAdjustments/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundleAdjustmentsChild" ], "operationId": "ContractServiceBundleAdjustmentsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/query": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleModel,ContractServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleModel,ContractServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/{id}": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceBundleModel,ContractServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/query/count": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/entityInformation": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundles" ], "operationId": "ContractServiceBundles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundles": { "get": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleModel,ContractServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundles/{id}": { "get": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceBundleModel,ContractServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundles/entityInformation": { "get": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundles/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundles/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundlesChild" ], "operationId": "ContractServiceBundlesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/query": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleUnitModel,ContractServiceBundleUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleUnitModel,ContractServiceBundleUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/{id}": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceBundleUnitModel,ContractServiceBundleUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/query/count": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/entityInformation": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceBundleUnits/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundleUnits" ], "operationId": "ContractServiceBundleUnits_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleUnits": { "get": { "tags": [ "ContractServiceBundleUnitsChild" ], "operationId": "ContractServiceBundleUnitsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceBundleUnitModel,ContractServiceBundleUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleUnits/{id}": { "get": { "tags": [ "ContractServiceBundleUnitsChild" ], "operationId": "ContractServiceBundleUnitsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceBundleUnitModel,ContractServiceBundleUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleUnits/entityInformation": { "get": { "tags": [ "ContractServiceBundleUnitsChild" ], "operationId": "ContractServiceBundleUnitsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleUnits/entityInformation/fields": { "get": { "tags": [ "ContractServiceBundleUnitsChild" ], "operationId": "ContractServiceBundleUnitsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceBundleUnits/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceBundleUnitsChild" ], "operationId": "ContractServiceBundleUnitsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/query": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceModel,ContractService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServices" ], "operationId": "ContractServices_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceModel,ContractService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/{id}": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceModel,ContractService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/query/count": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServices" ], "operationId": "ContractServices_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/entityInformation": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/entityInformation/fields": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServices/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServices" ], "operationId": "ContractServices_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Services": { "get": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceModel,ContractService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Services/{id}": { "get": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceModel,ContractService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Services/entityInformation": { "get": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Services/entityInformation/fields": { "get": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/Services/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServicesChild" ], "operationId": "ContractServicesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/query": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceUnitModel,ContractServiceUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceUnitModel,ContractServiceUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/{id}": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceUnitModel,ContractServiceUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/query/count": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/entityInformation": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/entityInformation/fields": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractServiceUnits/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceUnits" ], "operationId": "ContractServiceUnits_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceUnits": { "get": { "tags": [ "ContractServiceUnitsChild" ], "operationId": "ContractServiceUnitsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractServiceUnitModel,ContractServiceUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceUnits/{id}": { "get": { "tags": [ "ContractServiceUnitsChild" ], "operationId": "ContractServiceUnitsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractServiceUnitModel,ContractServiceUnit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceUnits/entityInformation": { "get": { "tags": [ "ContractServiceUnitsChild" ], "operationId": "ContractServiceUnitsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceUnits/entityInformation/fields": { "get": { "tags": [ "ContractServiceUnitsChild" ], "operationId": "ContractServiceUnitsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/ServiceUnits/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractServiceUnitsChild" ], "operationId": "ContractServiceUnitsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/query": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractTicketPurchaseModel,ContractTicketPurchase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractTicketPurchaseModel,ContractTicketPurchase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/{id}": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractTicketPurchaseModel,ContractTicketPurchase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/query/count": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/entityInformation": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/entityInformation/fields": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ContractTicketPurchases/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractTicketPurchases" ], "operationId": "ContractTicketPurchases_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/TicketPurchases": { "get": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ContractTicketPurchaseModel,ContractTicketPurchase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractTicketPurchaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractTicketPurchaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContractTicketPurchaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/TicketPurchases/{id}": { "get": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ContractTicketPurchaseModel,ContractTicketPurchase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/TicketPurchases/entityInformation": { "get": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/TicketPurchases/entityInformation/fields": { "get": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Contracts/{parentId}/TicketPurchases/entityInformation/userDefinedFields": { "get": { "tags": [ "ContractTicketPurchasesChild" ], "operationId": "ContractTicketPurchasesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/query": { "get": { "tags": [ "Countries" ], "operationId": "Countries_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CountryModel,Country]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Countries" ], "operationId": "Countries_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CountryModel,Country]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/{id}": { "get": { "tags": [ "Countries" ], "operationId": "Countries_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CountryModel,Country]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/query/count": { "get": { "tags": [ "Countries" ], "operationId": "Countries_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Countries" ], "operationId": "Countries_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries": { "put": { "tags": [ "Countries" ], "operationId": "Countries_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CountryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Countries" ], "operationId": "Countries_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CountryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/entityInformation": { "get": { "tags": [ "Countries" ], "operationId": "Countries_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/entityInformation/fields": { "get": { "tags": [ "Countries" ], "operationId": "Countries_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Countries/entityInformation/userDefinedFields": { "get": { "tags": [ "Countries" ], "operationId": "Countries_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/query": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CurrencyModel,Currency]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Currencies" ], "operationId": "Currencies_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[CurrencyModel,Currency]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/{id}": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[CurrencyModel,Currency]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/query/count": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Currencies" ], "operationId": "Currencies_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies": { "put": { "tags": [ "Currencies" ], "operationId": "Currencies_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CurrencyModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Currencies" ], "operationId": "Currencies_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CurrencyModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/entityInformation": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/entityInformation/fields": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Currencies/entityInformation/userDefinedFields": { "get": { "tags": [ "Currencies" ], "operationId": "Currencies_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/query": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTaskActivityLogModel,DeletedTaskActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTaskActivityLogModel,DeletedTaskActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/{id}": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DeletedTaskActivityLogModel,DeletedTaskActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/query/count": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/entityInformation": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/entityInformation/fields": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTaskActivityLogs/entityInformation/userDefinedFields": { "get": { "tags": [ "DeletedTaskActivityLogs" ], "operationId": "DeletedTaskActivityLogs_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/query": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTicketActivityLogModel,DeletedTicketActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTicketActivityLogModel,DeletedTicketActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/{id}": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DeletedTicketActivityLogModel,DeletedTicketActivityLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/query/count": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/entityInformation": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/entityInformation/fields": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketActivityLogs/entityInformation/userDefinedFields": { "get": { "tags": [ "DeletedTicketActivityLogs" ], "operationId": "DeletedTicketActivityLogs_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/query": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTicketLogModel,DeletedTicketLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DeletedTicketLogModel,DeletedTicketLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/{id}": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DeletedTicketLogModel,DeletedTicketLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/query/count": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/entityInformation": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/entityInformation/fields": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DeletedTicketLogs/entityInformation/userDefinedFields": { "get": { "tags": [ "DeletedTicketLogs" ], "operationId": "DeletedTicketLogs_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/query": { "get": { "tags": [ "Departments" ], "operationId": "Departments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DepartmentModel,Department]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Departments" ], "operationId": "Departments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DepartmentModel,Department]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/{id}": { "get": { "tags": [ "Departments" ], "operationId": "Departments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DepartmentModel,Department]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/query/count": { "get": { "tags": [ "Departments" ], "operationId": "Departments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Departments" ], "operationId": "Departments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments": { "put": { "tags": [ "Departments" ], "operationId": "Departments_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Departments" ], "operationId": "Departments_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Departments" ], "operationId": "Departments_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/entityInformation": { "get": { "tags": [ "Departments" ], "operationId": "Departments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/entityInformation/fields": { "get": { "tags": [ "Departments" ], "operationId": "Departments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Departments/entityInformation/userDefinedFields": { "get": { "tags": [ "Departments" ], "operationId": "Departments_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentAttachments/entityInformation": { "get": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentAttachments/entityInformation/fields": { "get": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentAttachments/query": { "get": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentAttachments/{id}": { "get": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentAttachments/query/count": { "get": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentAttachments" ], "operationId": "DocumentAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Attachments": { "get": { "tags": [ "DocumentAttachmentsChild" ], "operationId": "DocumentAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentAttachmentsChild" ], "operationId": "DocumentAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Attachments/{id}": { "get": { "tags": [ "DocumentAttachmentsChild" ], "operationId": "DocumentAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentAttachmentsChild" ], "operationId": "DocumentAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DocumentAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/query": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentCategoryModel,DocumentCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentCategoryModel,DocumentCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{id}": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentCategoryModel,DocumentCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/query/count": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories": { "put": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/entityInformation": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/entityInformation/fields": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentCategories" ], "operationId": "DocumentCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/query": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentChecklistItemModel,DocumentChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentChecklistItemModel,DocumentChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/{id}": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentChecklistItemModel,DocumentChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/query/count": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/entityInformation": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/entityInformation/fields": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentChecklistItems" ], "operationId": "DocumentChecklistItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistItems": { "get": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentChecklistItemModel,DocumentChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistItems/{id}": { "get": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentChecklistItemModel,DocumentChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistItems/entityInformation": { "get": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistItems/entityInformation/fields": { "get": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentChecklistItemsChild" ], "operationId": "DocumentChecklistItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistLibraries": { "post": { "tags": [ "DocumentChecklistLibraries" ], "operationId": "DocumentChecklistLibraries_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistLibraries/entityInformation": { "get": { "tags": [ "DocumentChecklistLibraries" ], "operationId": "DocumentChecklistLibraries_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistLibraries/entityInformation/fields": { "get": { "tags": [ "DocumentChecklistLibraries" ], "operationId": "DocumentChecklistLibraries_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentChecklistLibraries/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentChecklistLibraries" ], "operationId": "DocumentChecklistLibraries_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistLibraries": { "post": { "tags": [ "DocumentChecklistLibrariesChild" ], "operationId": "DocumentChecklistLibrariesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistLibraries/entityInformation": { "get": { "tags": [ "DocumentChecklistLibrariesChild" ], "operationId": "DocumentChecklistLibrariesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistLibraries/entityInformation/fields": { "get": { "tags": [ "DocumentChecklistLibrariesChild" ], "operationId": "DocumentChecklistLibrariesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ChecklistLibraries/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentChecklistLibrariesChild" ], "operationId": "DocumentChecklistLibrariesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/query": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/{id}": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/query/count": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/entityInformation": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentConfigurationItemAssociations" ], "operationId": "DocumentConfigurationItemAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemAssociations": { "get": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentConfigurationItemAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemAssociations/{id}": { "get": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemAssociations/entityInformation": { "get": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentConfigurationItemAssociationsChild" ], "operationId": "DocumentConfigurationItemAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/query": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/{id}": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/query/count": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/entityInformation": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentConfigurationItemCategoryAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociations" ], "operationId": "DocumentConfigurationItemCategoryAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemCategoryAssociations": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentConfigurationItemCategoryAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemCategoryAssociations/{id}": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemCategoryAssociations/entityInformation": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemCategoryAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ConfigurationItemCategoryAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentConfigurationItemCategoryAssociationsChild" ], "operationId": "DocumentConfigurationItemCategoryAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/query": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentNoteModel,DocumentNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentNoteModel,DocumentNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/{id}": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentNoteModel,DocumentNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/query/count": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/entityInformation": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/entityInformation/fields": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentNotes" ], "operationId": "DocumentNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Notes": { "get": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentNoteModel,DocumentNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Notes/{id}": { "get": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentNoteModel,DocumentNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Notes/entityInformation": { "get": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentNotesChild" ], "operationId": "DocumentNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/query": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentPlainTextContentModel,DocumentPlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentPlainTextContentModel,DocumentPlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/{id}": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentPlainTextContentModel,DocumentPlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/query/count": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/entityInformation": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/entityInformation/fields": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentPlainTextContent/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentPlainTextContent" ], "operationId": "DocumentPlainTextContent_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/PlainTextContent": { "get": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentPlainTextContentModel,DocumentPlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentPlainTextContentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentPlainTextContentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/PlainTextContent/{id}": { "get": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentPlainTextContentModel,DocumentPlainTextContent]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/PlainTextContent/entityInformation": { "get": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/PlainTextContent/entityInformation/fields": { "get": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/PlainTextContent/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentPlainTextContentChild" ], "operationId": "DocumentPlainTextContentChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/query": { "get": { "tags": [ "Documents" ], "operationId": "Documents_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentModel,Document]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Documents" ], "operationId": "Documents_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentModel,Document]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{id}": { "get": { "tags": [ "Documents" ], "operationId": "Documents_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentModel,Document]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/query/count": { "get": { "tags": [ "Documents" ], "operationId": "Documents_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Documents" ], "operationId": "Documents_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/entityInformation": { "get": { "tags": [ "Documents" ], "operationId": "Documents_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/entityInformation/fields": { "get": { "tags": [ "Documents" ], "operationId": "Documents_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/entityInformation/userDefinedFields": { "get": { "tags": [ "Documents" ], "operationId": "Documents_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{parentId}/Documents": { "get": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentModel,Document]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{parentId}/Documents/{id}": { "get": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentModel,Document]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{parentId}/Documents/entityInformation": { "get": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{parentId}/Documents/entityInformation/fields": { "get": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentCategories/{parentId}/Documents/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentsChild" ], "operationId": "DocumentsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/query": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTagAssociationModel,DocumentTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTagAssociationModel,DocumentTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/{id}": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentTagAssociationModel,DocumentTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/query/count": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/entityInformation": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentTagAssociations" ], "operationId": "DocumentTagAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TagAssociations": { "get": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTagAssociationModel,DocumentTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentTagAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TagAssociations/{id}": { "get": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentTagAssociationModel,DocumentTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TagAssociations/entityInformation": { "get": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TagAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentTagAssociationsChild" ], "operationId": "DocumentTagAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/query": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTicketAssociationModel,DocumentTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTicketAssociationModel,DocumentTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/{id}": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentTicketAssociationModel,DocumentTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/query/count": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/entityInformation": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentTicketAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentTicketAssociations" ], "operationId": "DocumentTicketAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TicketAssociations": { "get": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentTicketAssociationModel,DocumentTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentTicketAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TicketAssociations/{id}": { "get": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentTicketAssociationModel,DocumentTicketAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TicketAssociations/entityInformation": { "get": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TicketAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/TicketAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentTicketAssociationsChild" ], "operationId": "DocumentTicketAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/query": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToArticleAssociationModel,DocumentToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToArticleAssociationModel,DocumentToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/{id}": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentToArticleAssociationModel,DocumentToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/query/count": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/entityInformation": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToArticleAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentToArticleAssociations" ], "operationId": "DocumentToArticleAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ArticleAssociations": { "get": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToArticleAssociationModel,DocumentToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentToArticleAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ArticleAssociations/{id}": { "get": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentToArticleAssociationModel,DocumentToArticleAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ArticleAssociations/entityInformation": { "get": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ArticleAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/ArticleAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentToArticleAssociationsChild" ], "operationId": "DocumentToArticleAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/query": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/{id}": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/query/count": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/entityInformation": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DocumentToDocumentAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentToDocumentAssociations" ], "operationId": "DocumentToDocumentAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/DocumentAssociations": { "get": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DocumentToDocumentAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/DocumentAssociations/{id}": { "get": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/DocumentAssociations/entityInformation": { "get": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/DocumentAssociations/entityInformation/fields": { "get": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Documents/{parentId}/DocumentAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "DocumentToDocumentAssociationsChild" ], "operationId": "DocumentToDocumentAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/query": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DomainRegistrarModel,DomainRegistrar]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[DomainRegistrarModel,DomainRegistrar]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/{id}": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[DomainRegistrarModel,DomainRegistrar]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/query/count": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars": { "put": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DomainRegistrarModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DomainRegistrarModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DomainRegistrarModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/entityInformation": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/entityInformation/fields": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/DomainRegistrars/entityInformation/userDefinedFields": { "get": { "tags": [ "DomainRegistrars" ], "operationId": "DomainRegistrars_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItemAttachments/entityInformation": { "get": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItemAttachments/entityInformation/fields": { "get": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItemAttachments/query": { "get": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItemAttachments/{id}": { "get": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItemAttachments/query/count": { "get": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItemAttachments" ], "operationId": "ExpenseItemAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/{parentId}/Attachments": { "get": { "tags": [ "ExpenseItemAttachmentsChild" ], "operationId": "ExpenseItemAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItemAttachmentsChild" ], "operationId": "ExpenseItemAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/{parentId}/Attachments/{id}": { "get": { "tags": [ "ExpenseItemAttachmentsChild" ], "operationId": "ExpenseItemAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ExpenseItemAttachmentsChild" ], "operationId": "ExpenseItemAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseItemAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/query": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ExpenseItemModel,ExpenseItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ExpenseItemModel,ExpenseItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/{id}": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ExpenseItemModel,ExpenseItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/query/count": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/entityInformation": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/entityInformation/fields": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseItems/entityInformation/userDefinedFields": { "get": { "tags": [ "ExpenseItems" ], "operationId": "ExpenseItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Expenses/{parentId}/Items": { "get": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ExpenseItemModel,ExpenseItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Expenses/{parentId}/Items/{id}": { "get": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ExpenseItemModel,ExpenseItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Expenses/{parentId}/Items/entityInformation": { "get": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Expenses/{parentId}/Items/entityInformation/fields": { "get": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Expenses/{parentId}/Items/entityInformation/userDefinedFields": { "get": { "tags": [ "ExpenseItemsChild" ], "operationId": "ExpenseItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReportAttachments/entityInformation": { "get": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReportAttachments/entityInformation/fields": { "get": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReportAttachments/query": { "get": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReportAttachments/{id}": { "get": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReportAttachments/query/count": { "get": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReportAttachments" ], "operationId": "ExpenseReportAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/{parentId}/Attachments": { "get": { "tags": [ "ExpenseReportAttachmentsChild" ], "operationId": "ExpenseReportAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReportAttachmentsChild" ], "operationId": "ExpenseReportAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/{parentId}/Attachments/{id}": { "get": { "tags": [ "ExpenseReportAttachmentsChild" ], "operationId": "ExpenseReportAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ExpenseReportAttachmentsChild" ], "operationId": "ExpenseReportAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpenseReportAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/query": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ExpenseReportModel,ExpenseReport]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ExpenseReportModel,ExpenseReport]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/{id}": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ExpenseReportModel,ExpenseReport]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/query/count": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports": { "put": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseReportModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseReportModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpenseReportModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/entityInformation": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/entityInformation/fields": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ExpenseReports/entityInformation/userDefinedFields": { "get": { "tags": [ "ExpenseReports" ], "operationId": "ExpenseReports_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/query": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[HolidayModel,Holiday]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Holidays" ], "operationId": "Holidays_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[HolidayModel,Holiday]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/{id}": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[HolidayModel,Holiday]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/query/count": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Holidays" ], "operationId": "Holidays_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/entityInformation": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/entityInformation/fields": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Holidays/entityInformation/userDefinedFields": { "get": { "tags": [ "Holidays" ], "operationId": "Holidays_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{parentId}/Holidays": { "get": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[HolidayModel,Holiday]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidayModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidayModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidayModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{parentId}/Holidays/{id}": { "get": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[HolidayModel,Holiday]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{parentId}/Holidays/entityInformation": { "get": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{parentId}/Holidays/entityInformation/fields": { "get": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{parentId}/Holidays/entityInformation/userDefinedFields": { "get": { "tags": [ "HolidaysChild" ], "operationId": "HolidaysChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/query": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[HolidaySetModel,HolidaySet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[HolidaySetModel,HolidaySet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/{id}": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[HolidaySetModel,HolidaySet]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/query/count": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets": { "put": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidaySetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidaySetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HolidaySetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/entityInformation": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/entityInformation/fields": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/HolidaySets/entityInformation/userDefinedFields": { "get": { "tags": [ "HolidaySets" ], "operationId": "HolidaySets_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/query": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[IntegrationVendorInsightModel,IntegrationVendorInsight]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[IntegrationVendorInsightModel,IntegrationVendorInsight]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/{id}": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[IntegrationVendorInsightModel,IntegrationVendorInsight]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/query/count": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights": { "put": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorInsightModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorInsightModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorInsightModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/entityInformation": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/entityInformation/fields": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorInsights/entityInformation/userDefinedFields": { "get": { "tags": [ "IntegrationVendorInsights" ], "operationId": "IntegrationVendorInsights_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/query": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[IntegrationVendorWidgetModel,IntegrationVendorWidget]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[IntegrationVendorWidgetModel,IntegrationVendorWidget]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/{id}": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[IntegrationVendorWidgetModel,IntegrationVendorWidget]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/query/count": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets": { "put": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorWidgetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorWidgetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationVendorWidgetModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/entityInformation": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/entityInformation/fields": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/IntegrationVendorWidgets/entityInformation/userDefinedFields": { "get": { "tags": [ "IntegrationVendorWidgets" ], "operationId": "IntegrationVendorWidgets_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/query": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InternalLocationModel,InternalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InternalLocationModel,InternalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/{id}": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InternalLocationModel,InternalLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/query/count": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/entityInformation": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/entityInformation/fields": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocations/entityInformation/userDefinedFields": { "get": { "tags": [ "InternalLocations" ], "operationId": "InternalLocations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/query": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InternalLocationWithBusinessHoursModel,BusinessLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InternalLocationWithBusinessHoursModel,BusinessLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/{id}": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InternalLocationWithBusinessHoursModel,BusinessLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/query/count": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours": { "put": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InternalLocationWithBusinessHoursModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InternalLocationWithBusinessHoursModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InternalLocationWithBusinessHoursModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/entityInformation": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/entityInformation/fields": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InternalLocationWithBusinessHours/entityInformation/userDefinedFields": { "get": { "tags": [ "InternalLocationWithBusinessHours" ], "operationId": "InternalLocationWithBusinessHours_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/query": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryItemModel,InventoryItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryItemModel,InventoryItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{id}": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryItemModel,InventoryItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/query/count": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems": { "put": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/entityInformation": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/entityInformation/fields": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryItems" ], "operationId": "InventoryItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/query": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryItemSerialNumberModel,InventoryItemSerialNumber]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryItemSerialNumberModel,InventoryItemSerialNumber]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/{id}": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryItemSerialNumberModel,InventoryItemSerialNumber]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/query/count": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/entityInformation": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/entityInformation/fields": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItemSerialNumbers/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryItemSerialNumbers" ], "operationId": "InventoryItemSerialNumbers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{parentId}/SerialNumbers": { "get": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryItemSerialNumberModel,InventoryItemSerialNumber]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemSerialNumberModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemSerialNumberModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryItemSerialNumberModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{parentId}/SerialNumbers/{id}": { "get": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryItemSerialNumberModel,InventoryItemSerialNumber]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{parentId}/SerialNumbers/entityInformation": { "get": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{parentId}/SerialNumbers/entityInformation/fields": { "get": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryItems/{parentId}/SerialNumbers/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryItemSerialNumbersChild" ], "operationId": "InventoryItemSerialNumbersChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/query": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryLocationModel,InventoryLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryLocationModel,InventoryLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/{id}": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryLocationModel,InventoryLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/query/count": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations": { "put": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/entityInformation": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/entityInformation/fields": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryLocations/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryLocations" ], "operationId": "InventoryLocations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/query": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryProductModel,InventoryProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryProductModel,InventoryProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{id}": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryProductModel,InventoryProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/query/count": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts": { "put": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/entityInformation": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/entityInformation/fields": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryProducts" ], "operationId": "InventoryProducts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/query": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryStockedItemModel,InventoryStockedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryStockedItemModel,InventoryStockedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/{id}": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryStockedItemModel,InventoryStockedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/query/count": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/entityInformation": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItems/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItems" ], "operationId": "InventoryStockedItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsAdd/entityInformation": { "get": { "tags": [ "InventoryStockedItemsAdd" ], "operationId": "InventoryStockedItemsAdd_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsAdd/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsAdd" ], "operationId": "InventoryStockedItemsAdd_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsAdd/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsAdd" ], "operationId": "InventoryStockedItemsAdd_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsAdd": { "post": { "tags": [ "InventoryStockedItemsAddChild" ], "operationId": "InventoryStockedItemsAddChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryStockedItemAddModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsAdd/entityInformation": { "get": { "tags": [ "InventoryStockedItemsAddChild" ], "operationId": "InventoryStockedItemsAddChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsAdd/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsAddChild" ], "operationId": "InventoryStockedItemsAddChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsAdd/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsAddChild" ], "operationId": "InventoryStockedItemsAddChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItems": { "get": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryStockedItemModel,InventoryStockedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryStockedItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryStockedItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItems/{id}": { "get": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryStockedItemModel,InventoryStockedItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItems/entityInformation": { "get": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItems/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItems/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsChild" ], "operationId": "InventoryStockedItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsRemove/entityInformation": { "get": { "tags": [ "InventoryStockedItemsRemove" ], "operationId": "InventoryStockedItemsRemove_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsRemove/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsRemove" ], "operationId": "InventoryStockedItemsRemove_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsRemove/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsRemove" ], "operationId": "InventoryStockedItemsRemove_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsRemove": { "post": { "tags": [ "InventoryStockedItemsRemoveChild" ], "operationId": "InventoryStockedItemsRemoveChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryStockedItemRemoveModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsRemove/entityInformation": { "get": { "tags": [ "InventoryStockedItemsRemoveChild" ], "operationId": "InventoryStockedItemsRemoveChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsRemove/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsRemoveChild" ], "operationId": "InventoryStockedItemsRemoveChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsRemove/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsRemoveChild" ], "operationId": "InventoryStockedItemsRemoveChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsTransfer/entityInformation": { "get": { "tags": [ "InventoryStockedItemsTransfer" ], "operationId": "InventoryStockedItemsTransfer_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsTransfer/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsTransfer" ], "operationId": "InventoryStockedItemsTransfer_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryStockedItemsTransfer/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsTransfer" ], "operationId": "InventoryStockedItemsTransfer_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsTransfer": { "post": { "tags": [ "InventoryStockedItemsTransferChild" ], "operationId": "InventoryStockedItemsTransferChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryStockedItemTransferModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsTransfer/entityInformation": { "get": { "tags": [ "InventoryStockedItemsTransferChild" ], "operationId": "InventoryStockedItemsTransferChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsTransfer/entityInformation/fields": { "get": { "tags": [ "InventoryStockedItemsTransferChild" ], "operationId": "InventoryStockedItemsTransferChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryProducts/{parentId}/StockedItemsTransfer/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryStockedItemsTransferChild" ], "operationId": "InventoryStockedItemsTransferChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/query": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryTransferModel,InventoryTransfer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InventoryTransferModel,InventoryTransfer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/{id}": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InventoryTransferModel,InventoryTransfer]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/query/count": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers": { "post": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InventoryTransferModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/entityInformation": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/entityInformation/fields": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InventoryTransfers/entityInformation/userDefinedFields": { "get": { "tags": [ "InventoryTransfers" ], "operationId": "InventoryTransfers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/{id}/InvoiceMarkupHtml": { "get": { "tags": [ "InvoiceMarkupApiIntegration" ], "operationId": "InvoiceMarkupApiIntegration_QueryInvoiceMarkupHtml", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InvoiceMarkupResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/{id}/InvoiceMarkupXml": { "get": { "tags": [ "InvoiceMarkupApiIntegration" ], "operationId": "InvoiceMarkupApiIntegration_QueryInvoiceMarkupXml", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InvoiceMarkupResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/{id}/InvoicePdf": { "get": { "tags": [ "InvoiceMarkupApiIntegration" ], "operationId": "InvoiceMarkupApiIntegration_QueryInvoicePdf", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileQueryResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/query": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InvoiceModel,Invoice]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Invoices" ], "operationId": "Invoices_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InvoiceModel,Invoice]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/{id}": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InvoiceModel,Invoice]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/query/count": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Invoices" ], "operationId": "Invoices_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices": { "put": { "tags": [ "Invoices" ], "operationId": "Invoices_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InvoiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Invoices" ], "operationId": "Invoices_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InvoiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/entityInformation": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/entityInformation/fields": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Invoices/entityInformation/userDefinedFields": { "get": { "tags": [ "Invoices" ], "operationId": "Invoices_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/query": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InvoiceTemplateModel,InvoiceTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[InvoiceTemplateModel,InvoiceTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/{id}": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[InvoiceTemplateModel,InvoiceTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/query/count": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/entityInformation": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/entityInformation/fields": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/InvoiceTemplates/entityInformation/userDefinedFields": { "get": { "tags": [ "InvoiceTemplates" ], "operationId": "InvoiceTemplates_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/query": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[KnowledgeBaseArticleModel,KnowledgeBaseArticle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[KnowledgeBaseArticleModel,KnowledgeBaseArticle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/{id}": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[KnowledgeBaseArticleModel,KnowledgeBaseArticle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/query/count": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/entityInformation": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/entityInformation/fields": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseArticles/entityInformation/userDefinedFields": { "get": { "tags": [ "KnowledgeBaseArticles" ], "operationId": "KnowledgeBaseArticles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{parentId}/KnowledgeBaseArticles": { "get": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[KnowledgeBaseArticleModel,KnowledgeBaseArticle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseArticleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseArticleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseArticleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{parentId}/KnowledgeBaseArticles/{id}": { "get": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[KnowledgeBaseArticleModel,KnowledgeBaseArticle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{parentId}/KnowledgeBaseArticles/entityInformation": { "get": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{parentId}/KnowledgeBaseArticles/entityInformation/fields": { "get": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{parentId}/KnowledgeBaseArticles/entityInformation/userDefinedFields": { "get": { "tags": [ "KnowledgeBaseArticlesChild" ], "operationId": "KnowledgeBaseArticlesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/query": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[KnowledgeBaseCategoryModel,KnowledgeBaseCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[KnowledgeBaseCategoryModel,KnowledgeBaseCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/{id}": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[KnowledgeBaseCategoryModel,KnowledgeBaseCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/query/count": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories": { "put": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KnowledgeBaseCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/entityInformation": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/entityInformation/fields": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/KnowledgeBaseCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "KnowledgeBaseCategories" ], "operationId": "KnowledgeBaseCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/EntityInformation": { "get": { "tags": [ "MetadataApiIntegration" ], "operationId": "MetadataApiIntegration_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalEntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Modules": { "get": { "tags": [ "ModuleAccessApiIntegration" ], "operationId": "ModuleAccessApiIntegration_QueryModuleAccess", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ModuleAccessResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/query": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[NotificationHistoryModel,NotificationHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[NotificationHistoryModel,NotificationHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/{id}": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[NotificationHistoryModel,NotificationHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/query/count": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/entityInformation": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/entityInformation/fields": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/NotificationHistory/entityInformation/userDefinedFields": { "get": { "tags": [ "NotificationHistory" ], "operationId": "NotificationHistory_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/query": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OpportunityModel,Opportunity]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Opportunities" ], "operationId": "Opportunities_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OpportunityModel,Opportunity]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{id}": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OpportunityModel,Opportunity]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/query/count": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Opportunities" ], "operationId": "Opportunities_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities": { "put": { "tags": [ "Opportunities" ], "operationId": "Opportunities_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Opportunities" ], "operationId": "Opportunities_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Opportunities" ], "operationId": "Opportunities_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/entityInformation": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/entityInformation/fields": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/entityInformation/userDefinedFields": { "get": { "tags": [ "Opportunities" ], "operationId": "Opportunities_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityAttachments/entityInformation": { "get": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityAttachments/entityInformation/fields": { "get": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityAttachments/query": { "get": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityAttachments/{id}": { "get": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityAttachments/query/count": { "get": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OpportunityAttachments" ], "operationId": "OpportunityAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/Attachments": { "get": { "tags": [ "OpportunityAttachmentsChild" ], "operationId": "OpportunityAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OpportunityAttachmentsChild" ], "operationId": "OpportunityAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/Attachments/{id}": { "get": { "tags": [ "OpportunityAttachmentsChild" ], "operationId": "OpportunityAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "OpportunityAttachmentsChild" ], "operationId": "OpportunityAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OpportunityAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/query": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OpportunityCategoryModel,OpportunityCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OpportunityCategoryModel,OpportunityCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/{id}": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OpportunityCategoryModel,OpportunityCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/query/count": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories": { "put": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OpportunityCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/entityInformation": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/entityInformation/fields": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OpportunityCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "OpportunityCategories" ], "operationId": "OpportunityCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/query": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevel1Model,BusinessDivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevel1Model,BusinessDivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/{id}": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OrganizationalLevel1Model,BusinessDivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/query/count": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s": { "put": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel1Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel1Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel1Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/entityInformation": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/entityInformation/fields": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel1s/entityInformation/userDefinedFields": { "get": { "tags": [ "OrganizationalLevel1" ], "operationId": "OrganizationalLevel1_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/query": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevel2Model,BusinessSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevel2Model,BusinessSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/{id}": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OrganizationalLevel2Model,BusinessSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/query/count": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s": { "put": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel2Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel2Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevel2Model" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/entityInformation": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/entityInformation/fields": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevel2s/entityInformation/userDefinedFields": { "get": { "tags": [ "OrganizationalLevel2" ], "operationId": "OrganizationalLevel2_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/query": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevelAssociationModel,BusinessDivisionSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalLevelAssociationModel,BusinessDivisionSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{id}": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OrganizationalLevelAssociationModel,BusinessDivisionSubdivision]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/query/count": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations": { "put": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevelAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevelAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationalLevelAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/entityInformation": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/entityInformation/fields": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "OrganizationalLevelAssociation" ], "operationId": "OrganizationalLevelAssociation_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/query": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/{id}": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/query/count": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/entityInformation": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/entityInformation/fields": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalResources/entityInformation/userDefinedFields": { "get": { "tags": [ "OrganizationalResources" ], "operationId": "OrganizationalResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{parentId}/Resources": { "get": { "tags": [ "OrganizationalResourcesChild" ], "operationId": "OrganizationalResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{parentId}/Resources/{id}": { "get": { "tags": [ "OrganizationalResourcesChild" ], "operationId": "OrganizationalResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{parentId}/Resources/entityInformation": { "get": { "tags": [ "OrganizationalResourcesChild" ], "operationId": "OrganizationalResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{parentId}/Resources/entityInformation/fields": { "get": { "tags": [ "OrganizationalResourcesChild" ], "operationId": "OrganizationalResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/OrganizationalLevelAssociations/{parentId}/Resources/entityInformation/userDefinedFields": { "get": { "tags": [ "OrganizationalResourcesChild" ], "operationId": "OrganizationalResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/query": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PaymentTermModel,PaymentTerm]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PaymentTermModel,PaymentTerm]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/{id}": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PaymentTermModel,PaymentTerm]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/query/count": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms": { "put": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PaymentTermModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PaymentTermModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PaymentTermModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/entityInformation": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/entityInformation/fields": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PaymentTerms/entityInformation/userDefinedFields": { "get": { "tags": [ "PaymentTerms" ], "operationId": "PaymentTerms_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/query": { "get": { "tags": [ "Phases" ], "operationId": "Phases_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PhaseModel,Phase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Phases" ], "operationId": "Phases_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PhaseModel,Phase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/{id}": { "get": { "tags": [ "Phases" ], "operationId": "Phases_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PhaseModel,Phase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/query/count": { "get": { "tags": [ "Phases" ], "operationId": "Phases_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Phases" ], "operationId": "Phases_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/entityInformation": { "get": { "tags": [ "Phases" ], "operationId": "Phases_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/entityInformation/fields": { "get": { "tags": [ "Phases" ], "operationId": "Phases_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Phases/entityInformation/userDefinedFields": { "get": { "tags": [ "Phases" ], "operationId": "Phases_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Phases": { "get": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PhaseModel,Phase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PhaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PhaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PhaseModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Phases/{id}": { "get": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PhaseModel,Phase]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Phases/entityInformation": { "get": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Phases/entityInformation/fields": { "get": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Phases/entityInformation/userDefinedFields": { "get": { "tags": [ "PhasesChild" ], "operationId": "PhasesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/query": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListMaterialCodeModel,PriceListMaterialCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListMaterialCodeModel,PriceListMaterialCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/{id}": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListMaterialCodeModel,PriceListMaterialCode]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/query/count": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes": { "put": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListMaterialCodeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListMaterialCodeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/entityInformation": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/entityInformation/fields": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListMaterialCodes/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListMaterialCodes" ], "operationId": "PriceListMaterialCodes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/query": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListProductModel,PriceListProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListProductModel,PriceListProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/{id}": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListProductModel,PriceListProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/query/count": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts": { "put": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/entityInformation": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/entityInformation/fields": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProducts/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListProducts" ], "operationId": "PriceListProducts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/query": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListProductTierModel,PriceListProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListProductTierModel,PriceListProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/{id}": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListProductTierModel,PriceListProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/query/count": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers": { "put": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListProductTierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListProductTierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/entityInformation": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/entityInformation/fields": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListProductTiers/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListProductTiers" ], "operationId": "PriceListProductTiers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/query": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListRoleModel,PriceListRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListRoleModel,PriceListRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/{id}": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListRoleModel,PriceListRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/query/count": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles": { "put": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/entityInformation": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/entityInformation/fields": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListRoles" ], "operationId": "PriceListRoles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/query": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListServiceBundleModel,PriceListServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListServiceBundleModel,PriceListServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/{id}": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListServiceBundleModel,PriceListServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/query/count": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles": { "put": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/entityInformation": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/entityInformation/fields": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServiceBundles/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListServiceBundles" ], "operationId": "PriceListServiceBundles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/query": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListServiceModel,PriceListService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListServiceModel,PriceListService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/{id}": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListServiceModel,PriceListService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/query/count": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices": { "put": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/entityInformation": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/entityInformation/fields": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListServices/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListServices" ], "operationId": "PriceListServices_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/query": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListWorkTypeModifierModel,PriceListWorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PriceListWorkTypeModifierModel,PriceListWorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/{id}": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PriceListWorkTypeModifierModel,PriceListWorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/query/count": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers": { "put": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListWorkTypeModifierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PriceListWorkTypeModifierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/entityInformation": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/entityInformation/fields": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PriceListWorkTypeModifiers/entityInformation/userDefinedFields": { "get": { "tags": [ "PriceListWorkTypeModifiers" ], "operationId": "PriceListWorkTypeModifiers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/query": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductNoteModel,ProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductNoteModel,ProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/{id}": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductNoteModel,ProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/query/count": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/entityInformation": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/entityInformation/fields": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductNotes" ], "operationId": "ProductNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Notes": { "get": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductNoteModel,ProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Notes/{id}": { "get": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductNoteModel,ProductNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Notes/entityInformation": { "get": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductNotesChild" ], "operationId": "ProductNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/query": { "get": { "tags": [ "Products" ], "operationId": "Products_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductModel,Product]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Products" ], "operationId": "Products_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductModel,Product]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{id}": { "get": { "tags": [ "Products" ], "operationId": "Products_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductModel,Product]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/query/count": { "get": { "tags": [ "Products" ], "operationId": "Products_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Products" ], "operationId": "Products_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products": { "put": { "tags": [ "Products" ], "operationId": "Products_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Products" ], "operationId": "Products_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Products" ], "operationId": "Products_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/entityInformation": { "get": { "tags": [ "Products" ], "operationId": "Products_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/entityInformation/fields": { "get": { "tags": [ "Products" ], "operationId": "Products_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/entityInformation/userDefinedFields": { "get": { "tags": [ "Products" ], "operationId": "Products_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/query": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductTierModel,ProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductTierModel,ProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/{id}": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductTierModel,ProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/query/count": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/entityInformation": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/entityInformation/fields": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductTiers/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductTiers" ], "operationId": "ProductTiers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Tiers": { "get": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductTierModel,ProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductTierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductTierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductTierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Tiers/{id}": { "get": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductTierModel,ProductTier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Tiers/entityInformation": { "get": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Tiers/entityInformation/fields": { "get": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Tiers/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductTiersChild" ], "operationId": "ProductTiersChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/query": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductVendorModel,ProductVendor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductVendorModel,ProductVendor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/{id}": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductVendorModel,ProductVendor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/query/count": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/entityInformation": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/entityInformation/fields": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProductVendors/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductVendors" ], "operationId": "ProductVendors_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Vendors": { "get": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProductVendorModel,ProductVendor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductVendorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductVendorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductVendorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Vendors/{id}": { "get": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProductVendorModel,ProductVendor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Vendors/entityInformation": { "get": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Vendors/entityInformation/fields": { "get": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Products/{parentId}/Vendors/entityInformation/userDefinedFields": { "get": { "tags": [ "ProductVendorsChild" ], "operationId": "ProductVendorsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectAttachments/entityInformation": { "get": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectAttachments/entityInformation/fields": { "get": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectAttachments/query": { "get": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectAttachments/{id}": { "get": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectAttachments/query/count": { "get": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectAttachments" ], "operationId": "ProjectAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Attachments": { "get": { "tags": [ "ProjectAttachmentsChild" ], "operationId": "ProjectAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectAttachmentsChild" ], "operationId": "ProjectAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Attachments/{id}": { "get": { "tags": [ "ProjectAttachmentsChild" ], "operationId": "ProjectAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ProjectAttachmentsChild" ], "operationId": "ProjectAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/query": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectChargeModel,ProjectCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectChargeModel,ProjectCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/{id}": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProjectChargeModel,ProjectCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/query/count": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/entityInformation": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/entityInformation/fields": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectCharges/entityInformation/userDefinedFields": { "get": { "tags": [ "ProjectCharges" ], "operationId": "ProjectCharges_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Charges": { "get": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectChargeModel,ProjectCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Charges/{id}": { "get": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProjectChargeModel,ProjectCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Charges/entityInformation": { "get": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Charges/entityInformation/fields": { "get": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Charges/entityInformation/userDefinedFields": { "get": { "tags": [ "ProjectChargesChild" ], "operationId": "ProjectChargesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNoteAttachments/entityInformation": { "get": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNoteAttachments/entityInformation/fields": { "get": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNoteAttachments/query": { "get": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNoteAttachments/{id}": { "get": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNoteAttachments/query/count": { "get": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNoteAttachments" ], "operationId": "ProjectNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/{parentId}/Attachments": { "get": { "tags": [ "ProjectNoteAttachmentsChild" ], "operationId": "ProjectNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNoteAttachmentsChild" ], "operationId": "ProjectNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "ProjectNoteAttachmentsChild" ], "operationId": "ProjectNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ProjectNoteAttachmentsChild" ], "operationId": "ProjectNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/query": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectNoteModel,ProjectNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectNoteModel,ProjectNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/{id}": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProjectNoteModel,ProjectNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/query/count": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/entityInformation": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/entityInformation/fields": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ProjectNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "ProjectNotes" ], "operationId": "ProjectNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Notes": { "get": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectNoteModel,ProjectNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Notes/{id}": { "get": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProjectNoteModel,ProjectNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Notes/entityInformation": { "get": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "ProjectNotesChild" ], "operationId": "ProjectNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/query": { "get": { "tags": [ "Projects" ], "operationId": "Projects_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectModel,Project]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Projects" ], "operationId": "Projects_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ProjectModel,Project]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{id}": { "get": { "tags": [ "Projects" ], "operationId": "Projects_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ProjectModel,Project]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/query/count": { "get": { "tags": [ "Projects" ], "operationId": "Projects_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Projects" ], "operationId": "Projects_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects": { "put": { "tags": [ "Projects" ], "operationId": "Projects_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Projects" ], "operationId": "Projects_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Projects" ], "operationId": "Projects_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProjectModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/entityInformation": { "get": { "tags": [ "Projects" ], "operationId": "Projects_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/entityInformation/fields": { "get": { "tags": [ "Projects" ], "operationId": "Projects_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/entityInformation/userDefinedFields": { "get": { "tags": [ "Projects" ], "operationId": "Projects_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/query": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseApprovalModel,PurchaseApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseApprovalModel,PurchaseApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/{id}": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseApprovalModel,PurchaseApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/query/count": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals": { "put": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseApprovalModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseApprovalModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/entityInformation": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/entityInformation/fields": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseApprovals/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseApprovals" ], "operationId": "PurchaseApprovals_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/query": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/{id}": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/query/count": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/entityInformation": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/entityInformation/fields": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItemReceiving/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseOrderItemReceiving" ], "operationId": "PurchaseOrderItemReceiving_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{parentId}/Receiving": { "get": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderItemReceivingModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{parentId}/Receiving/{id}": { "get": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{parentId}/Receiving/entityInformation": { "get": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{parentId}/Receiving/entityInformation/fields": { "get": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{parentId}/Receiving/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseOrderItemReceivingChild" ], "operationId": "PurchaseOrderItemReceivingChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/query": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemModel,PurchaseOrderItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemModel,PurchaseOrderItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/{id}": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseOrderItemModel,PurchaseOrderItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/query/count": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/entityInformation": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/entityInformation/fields": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrderItems/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseOrderItems" ], "operationId": "PurchaseOrderItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{parentId}/Items": { "get": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderItemModel,PurchaseOrderItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{parentId}/Items/{id}": { "get": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseOrderItemModel,PurchaseOrderItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{parentId}/Items/entityInformation": { "get": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{parentId}/Items/entityInformation/fields": { "get": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{parentId}/Items/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseOrderItemsChild" ], "operationId": "PurchaseOrderItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/query": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderModel,PurchaseOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[PurchaseOrderModel,PurchaseOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/{id}": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[PurchaseOrderModel,PurchaseOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/query/count": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders": { "put": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PurchaseOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/entityInformation": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/entityInformation/fields": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/PurchaseOrders/entityInformation/userDefinedFields": { "get": { "tags": [ "PurchaseOrders" ], "operationId": "PurchaseOrders_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/query": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteItemModel,QuoteItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteItemModel,QuoteItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/{id}": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[QuoteItemModel,QuoteItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/query/count": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/entityInformation": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/entityInformation/fields": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteItems/entityInformation/userDefinedFields": { "get": { "tags": [ "QuoteItems" ], "operationId": "QuoteItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{parentId}/Items": { "get": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteItemModel,QuoteItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{parentId}/Items/{id}": { "get": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[QuoteItemModel,QuoteItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{parentId}/Items/entityInformation": { "get": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{parentId}/Items/entityInformation/fields": { "get": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{parentId}/Items/entityInformation/userDefinedFields": { "get": { "tags": [ "QuoteItemsChild" ], "operationId": "QuoteItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/query": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteLocationModel,QuoteLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteLocationModel,QuoteLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/{id}": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[QuoteLocationModel,QuoteLocation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/query/count": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations": { "put": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteLocationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/entityInformation": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/entityInformation/fields": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteLocations/entityInformation/userDefinedFields": { "get": { "tags": [ "QuoteLocations" ], "operationId": "QuoteLocations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/query": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteModel,Quote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Quotes" ], "operationId": "Quotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteModel,Quote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/{id}": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[QuoteModel,Quote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/query/count": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Quotes" ], "operationId": "Quotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes": { "put": { "tags": [ "Quotes" ], "operationId": "Quotes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Quotes" ], "operationId": "Quotes_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Quotes" ], "operationId": "Quotes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QuoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/entityInformation": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/entityInformation/fields": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Quotes/entityInformation/userDefinedFields": { "get": { "tags": [ "Quotes" ], "operationId": "Quotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/query": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteTemplateModel,QuoteTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[QuoteTemplateModel,QuoteTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/{id}": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[QuoteTemplateModel,QuoteTemplate]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/query/count": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/entityInformation": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/entityInformation/fields": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/QuoteTemplates/entityInformation/userDefinedFields": { "get": { "tags": [ "QuoteTemplates" ], "operationId": "QuoteTemplates_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceAttachments/entityInformation": { "get": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceAttachments/entityInformation/fields": { "get": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceAttachments/query": { "get": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceAttachments/{id}": { "get": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceAttachments/query/count": { "get": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceAttachments" ], "operationId": "ResourceAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Attachments": { "get": { "tags": [ "ResourceAttachmentsChild" ], "operationId": "ResourceAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceAttachmentsChild" ], "operationId": "ResourceAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Attachments/{id}": { "get": { "tags": [ "ResourceAttachmentsChild" ], "operationId": "ResourceAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ResourceAttachmentsChild" ], "operationId": "ResourceAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResourceAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/query": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/{id}": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/query/count": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/entityInformation": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/entityInformation/fields": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceDailyAvailabilities/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceDailyAvailabilities" ], "operationId": "ResourceDailyAvailabilities_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/DailyAvailabilities": { "get": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceDailyAvailabilityModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceDailyAvailabilityModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/DailyAvailabilities/{id}": { "get": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/DailyAvailabilities/entityInformation": { "get": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/DailyAvailabilities/entityInformation/fields": { "get": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/DailyAvailabilities/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceDailyAvailabilitiesChild" ], "operationId": "ResourceDailyAvailabilitiesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/query": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleDepartmentModel,ResourceRoleDepartment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleDepartmentModel,ResourceRoleDepartment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/{id}": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleDepartmentModel,ResourceRoleDepartment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/query/count": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/entityInformation": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/entityInformation/fields": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleDepartments/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRoleDepartments" ], "operationId": "ResourceRoleDepartments_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleDepartments": { "get": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleDepartmentModel,ResourceRoleDepartment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleDepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleDepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleDepartmentModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleDepartments/{id}": { "get": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleDepartmentModel,ResourceRoleDepartment]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleDepartments/entityInformation": { "get": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleDepartments/entityInformation/fields": { "get": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleDepartments/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRoleDepartmentsChild" ], "operationId": "ResourceRoleDepartmentsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/query": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleQueueModel,ResourceRoleQueue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleQueueModel,ResourceRoleQueue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/{id}": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/query/count": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/entityInformation": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/entityInformation/fields": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoleQueues/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRoleQueues" ], "operationId": "ResourceRoleQueues_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleQueues": { "get": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleQueueModel,ResourceRoleQueue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleQueueModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleQueueModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceRoleQueueModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleQueues/{id}": { "get": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleQueues/entityInformation": { "get": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleQueues/entityInformation/fields": { "get": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/RoleQueues/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRoleQueuesChild" ], "operationId": "ResourceRoleQueuesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/query": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleModel,ResourceRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleModel,ResourceRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/{id}": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleModel,ResourceRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/query/count": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/entityInformation": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/entityInformation/fields": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRoles" ], "operationId": "ResourceRoles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Roles": { "get": { "tags": [ "ResourceRolesChild" ], "operationId": "ResourceRolesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceRoleModel,ResourceRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Roles/{id}": { "get": { "tags": [ "ResourceRolesChild" ], "operationId": "ResourceRolesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceRoleModel,ResourceRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Roles/entityInformation": { "get": { "tags": [ "ResourceRolesChild" ], "operationId": "ResourceRolesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Roles/entityInformation/fields": { "get": { "tags": [ "ResourceRolesChild" ], "operationId": "ResourceRolesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Roles/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceRolesChild" ], "operationId": "ResourceRolesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/query": { "get": { "tags": [ "Resources" ], "operationId": "Resources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceModel,Resource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Resources" ], "operationId": "Resources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceModel,Resource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{id}": { "get": { "tags": [ "Resources" ], "operationId": "Resources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceModel,Resource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/query/count": { "get": { "tags": [ "Resources" ], "operationId": "Resources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Resources" ], "operationId": "Resources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources": { "put": { "tags": [ "Resources" ], "operationId": "Resources_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Resources" ], "operationId": "Resources_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/entityInformation": { "get": { "tags": [ "Resources" ], "operationId": "Resources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/entityInformation/fields": { "get": { "tags": [ "Resources" ], "operationId": "Resources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/entityInformation/userDefinedFields": { "get": { "tags": [ "Resources" ], "operationId": "Resources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/query": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/{id}": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/query/count": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/entityInformation": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/entityInformation/fields": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceServiceDeskRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceServiceDeskRoles" ], "operationId": "ResourceServiceDeskRoles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/ServiceDeskRoles": { "get": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceServiceDeskRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceServiceDeskRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceServiceDeskRoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/ServiceDeskRoles/{id}": { "get": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/ServiceDeskRoles/entityInformation": { "get": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/ServiceDeskRoles/entityInformation/fields": { "get": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/ServiceDeskRoles/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceServiceDeskRolesChild" ], "operationId": "ResourceServiceDeskRolesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/query": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceSkillModel,ResourceSkill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceSkillModel,ResourceSkill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/{id}": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceSkillModel,ResourceSkill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/query/count": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/entityInformation": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/entityInformation/fields": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceSkills/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceSkills" ], "operationId": "ResourceSkills_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Skills": { "get": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceSkillModel,ResourceSkill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceSkillModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceSkillModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Skills/{id}": { "get": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceSkillModel,ResourceSkill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Skills/entityInformation": { "get": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Skills/entityInformation/fields": { "get": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/Skills/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceSkillsChild" ], "operationId": "ResourceSkillsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffAdditional/entityInformation": { "get": { "tags": [ "ResourceTimeOffAdditional" ], "operationId": "ResourceTimeOffAdditional_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffAdditional/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffAdditional" ], "operationId": "ResourceTimeOffAdditional_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffAdditional/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffAdditional" ], "operationId": "ResourceTimeOffAdditional_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffAdditional": { "get": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceTimeOffAdditionalModel,ResourceTimeOffAdditional]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceTimeOffAdditionalModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResourceTimeOffAdditionalModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffAdditional/entityInformation": { "get": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffAdditional/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffAdditional/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffAdditionalChild" ], "operationId": "ResourceTimeOffAdditionalChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/query": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceTimeOffApproverModel,ResourceTimeOffApprover]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceTimeOffApproverModel,ResourceTimeOffApprover]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/{id}": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceTimeOffApproverModel,ResourceTimeOffApprover]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/query/count": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/entityInformation": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffApprovers/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffApprovers" ], "operationId": "ResourceTimeOffApprovers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffApprovers": { "get": { "tags": [ "ResourceTimeOffApproversChild" ], "operationId": "ResourceTimeOffApproversChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceTimeOffApproverModel,ResourceTimeOffApprover]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffApprovers/{id}": { "get": { "tags": [ "ResourceTimeOffApproversChild" ], "operationId": "ResourceTimeOffApproversChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceTimeOffApproverModel,ResourceTimeOffApprover]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffApprovers/entityInformation": { "get": { "tags": [ "ResourceTimeOffApproversChild" ], "operationId": "ResourceTimeOffApproversChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffApprovers/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffApproversChild" ], "operationId": "ResourceTimeOffApproversChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffApprovers/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffApproversChild" ], "operationId": "ResourceTimeOffApproversChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffBalances/entityInformation": { "get": { "tags": [ "ResourceTimeOffBalances" ], "operationId": "ResourceTimeOffBalances_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffBalances/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffBalances" ], "operationId": "ResourceTimeOffBalances_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ResourceTimeOffBalances/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffBalances" ], "operationId": "ResourceTimeOffBalances_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffBalances": { "get": { "tags": [ "ResourceTimeOffBalancesChild" ], "operationId": "ResourceTimeOffBalancesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ResourceTimeOffBalanceModel,ResourceTimeOffBalance]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffBalances/{year}": { "get": { "tags": [ "ResourceTimeOffBalancesChild" ], "operationId": "ResourceTimeOffBalancesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "year", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ResourceTimeOffBalanceModel,ResourceTimeOffBalance]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffBalances/entityInformation": { "get": { "tags": [ "ResourceTimeOffBalancesChild" ], "operationId": "ResourceTimeOffBalancesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffBalances/entityInformation/fields": { "get": { "tags": [ "ResourceTimeOffBalancesChild" ], "operationId": "ResourceTimeOffBalancesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffBalances/entityInformation/userDefinedFields": { "get": { "tags": [ "ResourceTimeOffBalancesChild" ], "operationId": "ResourceTimeOffBalancesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/query": { "get": { "tags": [ "Roles" ], "operationId": "Roles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[RoleModel,Role]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Roles" ], "operationId": "Roles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[RoleModel,Role]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/{id}": { "get": { "tags": [ "Roles" ], "operationId": "Roles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[RoleModel,Role]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/query/count": { "get": { "tags": [ "Roles" ], "operationId": "Roles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Roles" ], "operationId": "Roles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles": { "put": { "tags": [ "Roles" ], "operationId": "Roles_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Roles" ], "operationId": "Roles_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Roles" ], "operationId": "Roles_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RoleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/entityInformation": { "get": { "tags": [ "Roles" ], "operationId": "Roles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/entityInformation/fields": { "get": { "tags": [ "Roles" ], "operationId": "Roles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Roles/entityInformation/userDefinedFields": { "get": { "tags": [ "Roles" ], "operationId": "Roles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrderAttachments/entityInformation": { "get": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrderAttachments/entityInformation/fields": { "get": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrderAttachments/query": { "get": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrderAttachments/{id}": { "get": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrderAttachments/query/count": { "get": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SalesOrderAttachments" ], "operationId": "SalesOrderAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/{parentId}/Attachments": { "get": { "tags": [ "SalesOrderAttachmentsChild" ], "operationId": "SalesOrderAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SalesOrderAttachmentsChild" ], "operationId": "SalesOrderAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/{parentId}/Attachments/{id}": { "get": { "tags": [ "SalesOrderAttachmentsChild" ], "operationId": "SalesOrderAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "SalesOrderAttachmentsChild" ], "operationId": "SalesOrderAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SalesOrderAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/query": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SalesOrderModel,SalesOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SalesOrderModel,SalesOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/{id}": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SalesOrderModel,SalesOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/query/count": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders": { "put": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/entityInformation": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/entityInformation/fields": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SalesOrders/entityInformation/userDefinedFields": { "get": { "tags": [ "SalesOrders" ], "operationId": "SalesOrders_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/SalesOrders": { "get": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SalesOrderModel,SalesOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SalesOrderModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/SalesOrders/{id}": { "get": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SalesOrderModel,SalesOrder]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/SalesOrders/entityInformation": { "get": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/SalesOrders/entityInformation/fields": { "get": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Opportunities/{parentId}/SalesOrders/entityInformation/userDefinedFields": { "get": { "tags": [ "SalesOrdersChild" ], "operationId": "SalesOrdersChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/query": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceBundleModel,ServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceBundleModel,ServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{id}": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceBundleModel,ServiceBundle]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/query/count": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles": { "put": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceBundleModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/entityInformation": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/entityInformation/fields": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceBundles" ], "operationId": "ServiceBundles_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/query": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceBundleServiceModel,ServiceBundleService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceBundleServiceModel,ServiceBundleService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/{id}": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceBundleServiceModel,ServiceBundleService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/query/count": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/entityInformation": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/entityInformation/fields": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundleServices/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceBundleServices" ], "operationId": "ServiceBundleServices_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{parentId}/Services": { "get": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceBundleServiceModel,ServiceBundleService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceBundleServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{parentId}/Services/{id}": { "get": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceBundleServiceModel,ServiceBundleService]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{parentId}/Services/entityInformation": { "get": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{parentId}/Services/entityInformation/fields": { "get": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceBundles/{parentId}/Services/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceBundleServicesChild" ], "operationId": "ServiceBundleServicesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/query": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallModel,ServiceCall]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallModel,ServiceCall]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{id}": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallModel,ServiceCall]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/query/count": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls": { "put": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/entityInformation": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/entityInformation/fields": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCalls" ], "operationId": "ServiceCalls_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/query": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskResourceModel,ServiceCallTaskResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskResourceModel,ServiceCallTaskResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/{id}": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTaskResourceModel,ServiceCallTaskResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/query/count": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/entityInformation": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/entityInformation/fields": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTaskResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTaskResources" ], "operationId": "ServiceCallTaskResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{parentId}/Resources": { "get": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskResourceModel,ServiceCallTaskResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallTaskResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{parentId}/Resources/{id}": { "get": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTaskResourceModel,ServiceCallTaskResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{parentId}/Resources/entityInformation": { "get": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{parentId}/Resources/entityInformation/fields": { "get": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{parentId}/Resources/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTaskResourcesChild" ], "operationId": "ServiceCallTaskResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/query": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskModel,ServiceCallTask]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskModel,ServiceCallTask]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/{id}": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTaskModel,ServiceCallTask]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/query/count": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/entityInformation": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/entityInformation/fields": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTasks/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTasks" ], "operationId": "ServiceCallTasks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tasks": { "get": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTaskModel,ServiceCallTask]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallTaskModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tasks/{id}": { "get": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTaskModel,ServiceCallTask]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tasks/entityInformation": { "get": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tasks/entityInformation/fields": { "get": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tasks/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTasksChild" ], "operationId": "ServiceCallTasksChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/query": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketResourceModel,ServiceCallTicketResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketResourceModel,ServiceCallTicketResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/{id}": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTicketResourceModel,ServiceCallTicketResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/query/count": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/entityInformation": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/entityInformation/fields": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTicketResources/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTicketResources" ], "operationId": "ServiceCallTicketResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{parentId}/Resources": { "get": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketResourceModel,ServiceCallTicketResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallTicketResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{parentId}/Resources/{id}": { "get": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTicketResourceModel,ServiceCallTicketResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{parentId}/Resources/entityInformation": { "get": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{parentId}/Resources/entityInformation/fields": { "get": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{parentId}/Resources/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTicketResourcesChild" ], "operationId": "ServiceCallTicketResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/query": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketModel,ServiceCallTicket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketModel,ServiceCallTicket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/{id}": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTicketModel,ServiceCallTicket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/query/count": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/entityInformation": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/entityInformation/fields": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCallTickets/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTickets" ], "operationId": "ServiceCallTickets_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tickets": { "get": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceCallTicketModel,ServiceCallTicket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceCallTicketModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tickets/{id}": { "get": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceCallTicketModel,ServiceCallTicket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tickets/entityInformation": { "get": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tickets/entityInformation/fields": { "get": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceCalls/{parentId}/Tickets/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceCallTicketsChild" ], "operationId": "ServiceCallTicketsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/query": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/{id}": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/query/count": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/entityInformation": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/entityInformation/fields": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreementResults/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceLevelAgreementResults" ], "operationId": "ServiceLevelAgreementResults_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreements/{parentId}/Results": { "get": { "tags": [ "ServiceLevelAgreementResultsChild" ], "operationId": "ServiceLevelAgreementResultsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreements/{parentId}/Results/{id}": { "get": { "tags": [ "ServiceLevelAgreementResultsChild" ], "operationId": "ServiceLevelAgreementResultsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreements/{parentId}/Results/entityInformation": { "get": { "tags": [ "ServiceLevelAgreementResultsChild" ], "operationId": "ServiceLevelAgreementResultsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreements/{parentId}/Results/entityInformation/fields": { "get": { "tags": [ "ServiceLevelAgreementResultsChild" ], "operationId": "ServiceLevelAgreementResultsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ServiceLevelAgreements/{parentId}/Results/entityInformation/userDefinedFields": { "get": { "tags": [ "ServiceLevelAgreementResultsChild" ], "operationId": "ServiceLevelAgreementResultsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/query": { "get": { "tags": [ "Services" ], "operationId": "Services_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceModel,Service]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Services" ], "operationId": "Services_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ServiceModel,Service]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/{id}": { "get": { "tags": [ "Services" ], "operationId": "Services_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ServiceModel,Service]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/query/count": { "get": { "tags": [ "Services" ], "operationId": "Services_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Services" ], "operationId": "Services_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services": { "put": { "tags": [ "Services" ], "operationId": "Services_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Services" ], "operationId": "Services_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Services" ], "operationId": "Services_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/entityInformation": { "get": { "tags": [ "Services" ], "operationId": "Services_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/entityInformation/fields": { "get": { "tags": [ "Services" ], "operationId": "Services_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Services/entityInformation/userDefinedFields": { "get": { "tags": [ "Services" ], "operationId": "Services_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/query": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ShippingTypeModel,ShippingType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[ShippingTypeModel,ShippingType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/{id}": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[ShippingTypeModel,ShippingType]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/query/count": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/entityInformation": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/entityInformation/fields": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ShippingTypes/entityInformation/userDefinedFields": { "get": { "tags": [ "ShippingTypes" ], "operationId": "ShippingTypes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/query": { "get": { "tags": [ "Skills" ], "operationId": "Skills_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SkillModel,Skill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Skills" ], "operationId": "Skills_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SkillModel,Skill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/{id}": { "get": { "tags": [ "Skills" ], "operationId": "Skills_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SkillModel,Skill]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/query/count": { "get": { "tags": [ "Skills" ], "operationId": "Skills_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Skills" ], "operationId": "Skills_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/entityInformation": { "get": { "tags": [ "Skills" ], "operationId": "Skills_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/entityInformation/fields": { "get": { "tags": [ "Skills" ], "operationId": "Skills_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Skills/entityInformation/userDefinedFields": { "get": { "tags": [ "Skills" ], "operationId": "Skills_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/query": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SubscriptionPeriodModel,SubscriptionPeriod]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SubscriptionPeriodModel,SubscriptionPeriod]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/{id}": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/query/count": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/entityInformation": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/entityInformation/fields": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SubscriptionPeriods/entityInformation/userDefinedFields": { "get": { "tags": [ "SubscriptionPeriods" ], "operationId": "SubscriptionPeriods_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{parentId}/Periods": { "get": { "tags": [ "SubscriptionPeriodsChild" ], "operationId": "SubscriptionPeriodsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SubscriptionPeriodModel,SubscriptionPeriod]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{parentId}/Periods/{id}": { "get": { "tags": [ "SubscriptionPeriodsChild" ], "operationId": "SubscriptionPeriodsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{parentId}/Periods/entityInformation": { "get": { "tags": [ "SubscriptionPeriodsChild" ], "operationId": "SubscriptionPeriodsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{parentId}/Periods/entityInformation/fields": { "get": { "tags": [ "SubscriptionPeriodsChild" ], "operationId": "SubscriptionPeriodsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{parentId}/Periods/entityInformation/userDefinedFields": { "get": { "tags": [ "SubscriptionPeriodsChild" ], "operationId": "SubscriptionPeriodsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/query": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SubscriptionModel,Subscription]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SubscriptionModel,Subscription]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/{id}": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SubscriptionModel,Subscription]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/query/count": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions": { "put": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SubscriptionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SubscriptionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SubscriptionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/entityInformation": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/entityInformation/fields": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Subscriptions/entityInformation/userDefinedFields": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/query": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SurveyResultsModel,SurveyResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SurveyResultsModel,SurveyResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/{id}": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SurveyResultsModel,SurveyResults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/query/count": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/entityInformation": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/entityInformation/fields": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/SurveyResults/entityInformation/userDefinedFields": { "get": { "tags": [ "SurveyResults" ], "operationId": "SurveyResults_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/query": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SurveyModel,Survey]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Surveys" ], "operationId": "Surveys_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[SurveyModel,Survey]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/{id}": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[SurveyModel,Survey]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/query/count": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Surveys" ], "operationId": "Surveys_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/entityInformation": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/entityInformation/fields": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Surveys/entityInformation/userDefinedFields": { "get": { "tags": [ "Surveys" ], "operationId": "Surveys_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/query": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagAliasModel,TagAlias]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagAliases" ], "operationId": "TagAliases_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagAliasModel,TagAlias]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/{id}": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TagAliasModel,TagAlias]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/query/count": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagAliases" ], "operationId": "TagAliases_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/entityInformation": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/entityInformation/fields": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagAliases/entityInformation/userDefinedFields": { "get": { "tags": [ "TagAliases" ], "operationId": "TagAliases_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{parentId}/Aliases": { "get": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagAliasModel,TagAlias]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagAliasModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{parentId}/Aliases/{id}": { "get": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TagAliasModel,TagAlias]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{parentId}/Aliases/entityInformation": { "get": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{parentId}/Aliases/entityInformation/fields": { "get": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{parentId}/Aliases/entityInformation/userDefinedFields": { "get": { "tags": [ "TagAliasesChild" ], "operationId": "TagAliasesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/query": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagGroupModel,TagGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagGroups" ], "operationId": "TagGroups_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagGroupModel,TagGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/{id}": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TagGroupModel,TagGroup]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TagGroups" ], "operationId": "TagGroups_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/query/count": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagGroups" ], "operationId": "TagGroups_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups": { "put": { "tags": [ "TagGroups" ], "operationId": "TagGroups_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TagGroups" ], "operationId": "TagGroups_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TagGroups" ], "operationId": "TagGroups_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagGroupModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/entityInformation": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/entityInformation/fields": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TagGroups/entityInformation/userDefinedFields": { "get": { "tags": [ "TagGroups" ], "operationId": "TagGroups_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/query": { "get": { "tags": [ "Tags" ], "operationId": "Tags_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagModel,Tag]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tags" ], "operationId": "Tags_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TagModel,Tag]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/{id}": { "get": { "tags": [ "Tags" ], "operationId": "Tags_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TagModel,Tag]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Tags" ], "operationId": "Tags_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/query/count": { "get": { "tags": [ "Tags" ], "operationId": "Tags_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tags" ], "operationId": "Tags_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags": { "put": { "tags": [ "Tags" ], "operationId": "Tags_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tags" ], "operationId": "Tags_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Tags" ], "operationId": "Tags_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TagModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/entityInformation": { "get": { "tags": [ "Tags" ], "operationId": "Tags_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/entityInformation/fields": { "get": { "tags": [ "Tags" ], "operationId": "Tags_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tags/entityInformation/userDefinedFields": { "get": { "tags": [ "Tags" ], "operationId": "Tags_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskAttachments/entityInformation": { "get": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskAttachments/entityInformation/fields": { "get": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskAttachments/query": { "get": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskAttachments/{id}": { "get": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskAttachments/query/count": { "get": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskAttachments" ], "operationId": "TaskAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Attachments": { "get": { "tags": [ "TaskAttachmentsChild" ], "operationId": "TaskAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskAttachmentsChild" ], "operationId": "TaskAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Attachments/{id}": { "get": { "tags": [ "TaskAttachmentsChild" ], "operationId": "TaskAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TaskAttachmentsChild" ], "operationId": "TaskAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNoteAttachments/entityInformation": { "get": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNoteAttachments/entityInformation/fields": { "get": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNoteAttachments/query": { "get": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNoteAttachments/{id}": { "get": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNoteAttachments/query/count": { "get": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNoteAttachments" ], "operationId": "TaskNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/{parentId}/Attachments": { "get": { "tags": [ "TaskNoteAttachmentsChild" ], "operationId": "TaskNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNoteAttachmentsChild" ], "operationId": "TaskNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "TaskNoteAttachmentsChild" ], "operationId": "TaskNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TaskNoteAttachmentsChild" ], "operationId": "TaskNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/query": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskNoteModel,TaskNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskNoteModel,TaskNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/{id}": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskNoteModel,TaskNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/query/count": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes": { "put": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/entityInformation": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/entityInformation/fields": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskNotes" ], "operationId": "TaskNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Notes": { "get": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskNoteModel,TaskNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Notes/{id}": { "get": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskNoteModel,TaskNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Notes/entityInformation": { "get": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskNotesChild" ], "operationId": "TaskNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/query": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskPredecessorModel,TaskPredecessor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskPredecessorModel,TaskPredecessor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/{id}": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/query/count": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/entityInformation": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/entityInformation/fields": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskPredecessors/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskPredecessors" ], "operationId": "TaskPredecessors_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Predecessors": { "get": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskPredecessorModel,TaskPredecessor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskPredecessorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskPredecessorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskPredecessorModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Predecessors/{id}": { "get": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Predecessors/entityInformation": { "get": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Predecessors/entityInformation/fields": { "get": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/Predecessors/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskPredecessorsChild" ], "operationId": "TaskPredecessorsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/query": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskModel,Task]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tasks" ], "operationId": "Tasks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskModel,Task]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{id}": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskModel,Task]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/query/count": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tasks" ], "operationId": "Tasks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/entityInformation": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/entityInformation/fields": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/entityInformation/userDefinedFields": { "get": { "tags": [ "Tasks" ], "operationId": "Tasks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Tasks": { "get": { "tags": [ "TasksChild" ], "operationId": "TasksChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskModel,Task]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TasksChild" ], "operationId": "TasksChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TasksChild" ], "operationId": "TasksChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TasksChild" ], "operationId": "TasksChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Tasks/{id}": { "get": { "tags": [ "TasksChild" ], "operationId": "TasksChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskModel,Task]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Tasks/entityInformation": { "get": { "tags": [ "TasksChild" ], "operationId": "TasksChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Tasks/entityInformation/fields": { "get": { "tags": [ "TasksChild" ], "operationId": "TasksChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Projects/{parentId}/Tasks/entityInformation/userDefinedFields": { "get": { "tags": [ "TasksChild" ], "operationId": "TasksChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/query": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskSecondaryResourceModel,TaskSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskSecondaryResourceModel,TaskSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/{id}": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskSecondaryResourceModel,TaskSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/query/count": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/entityInformation": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/entityInformation/fields": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaskSecondaryResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskSecondaryResources" ], "operationId": "TaskSecondaryResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/SecondaryResources": { "get": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaskSecondaryResourceModel,TaskSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaskSecondaryResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/SecondaryResources/{id}": { "get": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaskSecondaryResourceModel,TaskSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/SecondaryResources/entityInformation": { "get": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/SecondaryResources/entityInformation/fields": { "get": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tasks/{parentId}/SecondaryResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TaskSecondaryResourcesChild" ], "operationId": "TaskSecondaryResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/query": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxCategoryModel,TaxCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxCategoryModel,TaxCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/{id}": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaxCategoryModel,TaxCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/query/count": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories": { "put": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/entityInformation": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/entityInformation/fields": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "TaxCategories" ], "operationId": "TaxCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/query": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxModel,Tax]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Taxes" ], "operationId": "Taxes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxModel,Tax]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/{id}": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaxModel,Tax]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/query/count": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Taxes" ], "operationId": "Taxes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes": { "put": { "tags": [ "Taxes" ], "operationId": "Taxes_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Taxes" ], "operationId": "Taxes_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Taxes" ], "operationId": "Taxes_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/entityInformation": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/entityInformation/fields": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Taxes/entityInformation/userDefinedFields": { "get": { "tags": [ "Taxes" ], "operationId": "Taxes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/query": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxRegionModel,TaxRegion]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TaxRegionModel,TaxRegion]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/{id}": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TaxRegionModel,TaxRegion]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/query/count": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions": { "put": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxRegionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxRegionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TaxRegionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/entityInformation": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/entityInformation/fields": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TaxRegions/entityInformation/userDefinedFields": { "get": { "tags": [ "TaxRegions" ], "operationId": "TaxRegions_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ThresholdInformation": { "get": { "tags": [ "ThresholdApiIntegration" ], "operationId": "ThresholdApiIntegration_QueryThresholdInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThresholdStatusResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/query": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/{id}": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/query/count": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/entityInformation": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/entityInformation/fields": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalConfigurationItems/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketAdditionalConfigurationItems" ], "operationId": "TicketAdditionalConfigurationItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalConfigurationItems": { "get": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketAdditionalConfigurationItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalConfigurationItems/{id}": { "get": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalConfigurationItems/entityInformation": { "get": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalConfigurationItems/entityInformation/fields": { "get": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalConfigurationItems/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketAdditionalConfigurationItemsChild" ], "operationId": "TicketAdditionalConfigurationItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/query": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalContactModel,TicketAdditionalContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalContactModel,TicketAdditionalContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/{id}": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketAdditionalContactModel,TicketAdditionalContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/query/count": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/entityInformation": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/entityInformation/fields": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAdditionalContacts/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketAdditionalContacts" ], "operationId": "TicketAdditionalContacts_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalContacts": { "get": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketAdditionalContactModel,TicketAdditionalContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketAdditionalContactModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalContacts/{id}": { "get": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketAdditionalContactModel,TicketAdditionalContact]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalContacts/entityInformation": { "get": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalContacts/entityInformation/fields": { "get": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/AdditionalContacts/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketAdditionalContactsChild" ], "operationId": "TicketAdditionalContactsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAttachments/entityInformation": { "get": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAttachments/entityInformation/fields": { "get": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAttachments/query": { "get": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAttachments/{id}": { "get": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketAttachments/query/count": { "get": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAttachments" ], "operationId": "TicketAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Attachments": { "get": { "tags": [ "TicketAttachmentsChild" ], "operationId": "TicketAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketAttachmentsChild" ], "operationId": "TicketAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Attachments/{id}": { "get": { "tags": [ "TicketAttachmentsChild" ], "operationId": "TicketAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketAttachmentsChild" ], "operationId": "TicketAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/query": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketCategoryModel,TicketCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketCategoryModel,TicketCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{id}": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketCategoryModel,TicketCategory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/query/count": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories": { "put": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketCategoryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/entityInformation": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/entityInformation/fields": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketCategories" ], "operationId": "TicketCategories_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/query": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/{id}": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/query/count": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/entityInformation": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/entityInformation/fields": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategoryFieldDefaults/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketCategoryFieldDefaults" ], "operationId": "TicketCategoryFieldDefaults_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{parentId}/FieldDefaults": { "get": { "tags": [ "TicketCategoryFieldDefaultsChild" ], "operationId": "TicketCategoryFieldDefaultsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{parentId}/FieldDefaults/{id}": { "get": { "tags": [ "TicketCategoryFieldDefaultsChild" ], "operationId": "TicketCategoryFieldDefaultsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{parentId}/FieldDefaults/entityInformation": { "get": { "tags": [ "TicketCategoryFieldDefaultsChild" ], "operationId": "TicketCategoryFieldDefaultsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{parentId}/FieldDefaults/entityInformation/fields": { "get": { "tags": [ "TicketCategoryFieldDefaultsChild" ], "operationId": "TicketCategoryFieldDefaultsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCategories/{parentId}/FieldDefaults/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketCategoryFieldDefaultsChild" ], "operationId": "TicketCategoryFieldDefaultsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/query": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/{id}": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/query/count": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/entityInformation": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/entityInformation/fields": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChangeRequestApprovals/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChangeRequestApprovals" ], "operationId": "TicketChangeRequestApprovals_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChangeRequestApprovals": { "get": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChangeRequestApprovalModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChangeRequestApprovals/{id}": { "get": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChangeRequestApprovals/entityInformation": { "get": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChangeRequestApprovals/entityInformation/fields": { "get": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChangeRequestApprovals/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChangeRequestApprovalsChild" ], "operationId": "TicketChangeRequestApprovalsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/query": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChargeModel,TicketCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChargeModel,TicketCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/{id}": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChargeModel,TicketCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/query/count": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/entityInformation": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/entityInformation/fields": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketCharges/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketCharges" ], "operationId": "TicketCharges_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Charges": { "get": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChargeModel,TicketCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChargeModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Charges/{id}": { "get": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChargeModel,TicketCost]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Charges/entityInformation": { "get": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Charges/entityInformation/fields": { "get": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Charges/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChargesChild" ], "operationId": "TicketChargesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/query": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChecklistItemModel,TicketChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChecklistItemModel,TicketChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/{id}": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChecklistItemModel,TicketChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/query/count": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/entityInformation": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/entityInformation/fields": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChecklistItems" ], "operationId": "TicketChecklistItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistItems": { "get": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketChecklistItemModel,TicketChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChecklistItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistItems/{id}": { "get": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketChecklistItemModel,TicketChecklistItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistItems/entityInformation": { "get": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistItems/entityInformation/fields": { "get": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistItems/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChecklistItemsChild" ], "operationId": "TicketChecklistItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistLibraries": { "post": { "tags": [ "TicketChecklistLibraries" ], "operationId": "TicketChecklistLibraries_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistLibraries/entityInformation": { "get": { "tags": [ "TicketChecklistLibraries" ], "operationId": "TicketChecklistLibraries_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistLibraries/entityInformation/fields": { "get": { "tags": [ "TicketChecklistLibraries" ], "operationId": "TicketChecklistLibraries_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketChecklistLibraries/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChecklistLibraries" ], "operationId": "TicketChecklistLibraries_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistLibraries": { "post": { "tags": [ "TicketChecklistLibrariesChild" ], "operationId": "TicketChecklistLibrariesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketChecklistLibraryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistLibraries/entityInformation": { "get": { "tags": [ "TicketChecklistLibrariesChild" ], "operationId": "TicketChecklistLibrariesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistLibraries/entityInformation/fields": { "get": { "tags": [ "TicketChecklistLibrariesChild" ], "operationId": "TicketChecklistLibrariesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/ChecklistLibraries/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketChecklistLibrariesChild" ], "operationId": "TicketChecklistLibrariesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/query": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketHistoryModel,TicketHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketHistoryModel,TicketHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/{id}": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketHistoryModel,TicketHistory]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/query/count": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/entityInformation": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/entityInformation/fields": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketHistory/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketHistory" ], "operationId": "TicketHistory_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteAttachments/entityInformation": { "get": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteAttachments/entityInformation/fields": { "get": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteAttachments/query": { "get": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteAttachments/{id}": { "get": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteAttachments/query/count": { "get": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteAttachments" ], "operationId": "TicketNoteAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/{parentId}/Attachments": { "get": { "tags": [ "TicketNoteAttachmentsChild" ], "operationId": "TicketNoteAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteAttachmentsChild" ], "operationId": "TicketNoteAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/{parentId}/Attachments/{id}": { "get": { "tags": [ "TicketNoteAttachmentsChild" ], "operationId": "TicketNoteAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketNoteAttachmentsChild" ], "operationId": "TicketNoteAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketNoteAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/query": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteModel,TicketNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteModel,TicketNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/{id}": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteModel,TicketNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/query/count": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/entityInformation": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/entityInformation/fields": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNotes/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNotes" ], "operationId": "TicketNotes_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Notes": { "get": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteModel,TicketNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Notes/{id}": { "get": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteModel,TicketNote]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Notes/entityInformation": { "get": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Notes/entityInformation/fields": { "get": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/Notes/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNotesChild" ], "operationId": "TicketNotesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/query": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/{id}": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/query/count": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/entityInformation": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/entityInformation/fields": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNoteWebhookExcludedResources" ], "operationId": "TicketNoteWebhookExcludedResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/ExcludedResources": { "get": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookExcludedResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/ExcludedResources/{id}": { "get": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/ExcludedResources/entityInformation": { "get": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/ExcludedResources/entityInformation/fields": { "get": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/ExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNoteWebhookExcludedResourcesChild" ], "operationId": "TicketNoteWebhookExcludedResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/query": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookFieldModel,TicketNoteWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookFieldModel,TicketNoteWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/{id}": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteWebhookFieldModel,TicketNoteWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/query/count": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/entityInformation": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/entityInformation/fields": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhookFields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNoteWebhookFields" ], "operationId": "TicketNoteWebhookFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/Fields": { "get": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookFieldModel,TicketNoteWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/Fields/{id}": { "get": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteWebhookFieldModel,TicketNoteWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/Fields/entityInformation": { "get": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/Fields/entityInformation/fields": { "get": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{parentId}/Fields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNoteWebhookFieldsChild" ], "operationId": "TicketNoteWebhookFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/query": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookModel,TicketNoteWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketNoteWebhookModel,TicketNoteWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/{id}": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketNoteWebhookModel,TicketNoteWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/query/count": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks": { "put": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketNoteWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/entityInformation": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/entityInformation/fields": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketNoteWebhooks/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketNoteWebhooks" ], "operationId": "TicketNoteWebhooks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/query": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketRmaCreditModel,TicketRmaCredit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketRmaCreditModel,TicketRmaCredit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/{id}": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketRmaCreditModel,TicketRmaCredit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/query/count": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/entityInformation": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/entityInformation/fields": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketRmaCredits/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketRmaCredits" ], "operationId": "TicketRmaCredits_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/RmaCredits": { "get": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketRmaCreditModel,TicketRmaCredit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketRmaCreditModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketRmaCreditModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketRmaCreditModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/RmaCredits/{id}": { "get": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketRmaCreditModel,TicketRmaCredit]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/RmaCredits/entityInformation": { "get": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/RmaCredits/entityInformation/fields": { "get": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/RmaCredits/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketRmaCreditsChild" ], "operationId": "TicketRmaCreditsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/query": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketModel,Ticket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tickets" ], "operationId": "Tickets_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketModel,Ticket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{id}": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketModel,Ticket]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/query/count": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tickets" ], "operationId": "Tickets_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets": { "put": { "tags": [ "Tickets" ], "operationId": "Tickets_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Tickets" ], "operationId": "Tickets_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Tickets" ], "operationId": "Tickets_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/entityInformation": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/entityInformation/fields": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/entityInformation/userDefinedFields": { "get": { "tags": [ "Tickets" ], "operationId": "Tickets_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/query": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketSecondaryResourceModel,TicketSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketSecondaryResourceModel,TicketSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/{id}": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketSecondaryResourceModel,TicketSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/query/count": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/entityInformation": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/entityInformation/fields": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketSecondaryResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketSecondaryResources" ], "operationId": "TicketSecondaryResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/SecondaryResources": { "get": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketSecondaryResourceModel,TicketSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketSecondaryResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/SecondaryResources/{id}": { "get": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketSecondaryResourceModel,TicketSecondaryResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/SecondaryResources/entityInformation": { "get": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/SecondaryResources/entityInformation/fields": { "get": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/SecondaryResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketSecondaryResourcesChild" ], "operationId": "TicketSecondaryResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/query": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketTagAssociationModel,TicketTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketTagAssociationModel,TicketTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/{id}": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketTagAssociationModel,TicketTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/query/count": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/entityInformation": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/entityInformation/fields": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketTagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketTagAssociations" ], "operationId": "TicketTagAssociations_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/TagAssociations": { "get": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketTagAssociationModel,TicketTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketTagAssociationModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/TagAssociations/{id}": { "get": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketTagAssociationModel,TicketTagAssociation]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/TagAssociations/entityInformation": { "get": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/TagAssociations/entityInformation/fields": { "get": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Tickets/{parentId}/TagAssociations/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketTagAssociationsChild" ], "operationId": "TicketTagAssociationsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/query": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/{id}": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/query/count": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/entityInformation": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/entityInformation/fields": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookExcludedResources" ], "operationId": "TicketWebhookExcludedResources_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/ExcludedResources": { "get": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookExcludedResourceModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/ExcludedResources/{id}": { "get": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/ExcludedResources/entityInformation": { "get": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/ExcludedResources/entityInformation/fields": { "get": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/ExcludedResources/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookExcludedResourcesChild" ], "operationId": "TicketWebhookExcludedResourcesChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/query": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookFieldModel,TicketWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookFieldModel,TicketWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/{id}": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookFieldModel,TicketWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/query/count": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/entityInformation": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/entityInformation/fields": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookFields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookFields" ], "operationId": "TicketWebhookFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/Fields": { "get": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookFieldModel,TicketWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/Fields/{id}": { "get": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookFieldModel,TicketWebhookField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/Fields/entityInformation": { "get": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/Fields/entityInformation/fields": { "get": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/Fields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookFieldsChild" ], "operationId": "TicketWebhookFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/query": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookModel,TicketWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookModel,TicketWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{id}": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookModel,TicketWebhook]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/query/count": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks": { "put": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/entityInformation": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/entityInformation/fields": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhooks" ], "operationId": "TicketWebhooks_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/query": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookUdfFieldModel,TicketWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookUdfFieldModel,TicketWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/{id}": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookUdfFieldModel,TicketWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/query/count": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/entityInformation": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/entityInformation/fields": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhookUdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookUdfFields" ], "operationId": "TicketWebhookUdfFields_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/UdfFields": { "get": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TicketWebhookUdfFieldModel,TicketWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TicketWebhookUdfFieldModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/UdfFields/{id}": { "get": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TicketWebhookUdfFieldModel,TicketWebhookUdfField]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/UdfFields/entityInformation": { "get": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/UdfFields/entityInformation/fields": { "get": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TicketWebhooks/{parentId}/UdfFields/entityInformation/userDefinedFields": { "get": { "tags": [ "TicketWebhookUdfFieldsChild" ], "operationId": "TicketWebhookUdfFieldsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/query": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TimeEntryModel,TimeEntry]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TimeEntryModel,TimeEntry]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/{id}": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TimeEntryModel,TimeEntry]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/query/count": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries": { "put": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeEntryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeEntryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeEntryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/entityInformation": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/entityInformation/fields": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeEntries" ], "operationId": "TimeEntries_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntryAttachments/entityInformation": { "get": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntryAttachments/entityInformation/fields": { "get": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntryAttachments/query": { "get": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntryAttachments/{id}": { "get": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntryAttachments/query/count": { "get": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntryAttachments" ], "operationId": "TimeEntryAttachments_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/{parentId}/Attachments": { "get": { "tags": [ "TimeEntryAttachmentsChild" ], "operationId": "TimeEntryAttachmentsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeEntryAttachmentsChild" ], "operationId": "TimeEntryAttachmentsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeEntries/{parentId}/Attachments/{id}": { "get": { "tags": [ "TimeEntryAttachmentsChild" ], "operationId": "TimeEntryAttachmentsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "TimeEntryAttachmentsChild" ], "operationId": "TimeEntryAttachmentsChild_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TimeEntryAttachmentModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/query": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TimeOffRequestModel,TimeOffRequest]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TimeOffRequestModel,TimeOffRequest]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{id}": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TimeOffRequestModel,TimeOffRequest]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/query/count": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/entityInformation": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/entityInformation/fields": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequests" ], "operationId": "TimeOffRequests_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsApprove/entityInformation": { "get": { "tags": [ "TimeOffRequestsApprove" ], "operationId": "TimeOffRequestsApprove_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsApprove/entityInformation/fields": { "get": { "tags": [ "TimeOffRequestsApprove" ], "operationId": "TimeOffRequestsApprove_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsApprove/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequestsApprove" ], "operationId": "TimeOffRequestsApprove_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Approve": { "get": { "tags": [ "TimeOffRequestsApproveChild" ], "operationId": "TimeOffRequestsApproveChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Approve/entityInformation": { "get": { "tags": [ "TimeOffRequestsApproveChild" ], "operationId": "TimeOffRequestsApproveChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Approve/entityInformation/fields": { "get": { "tags": [ "TimeOffRequestsApproveChild" ], "operationId": "TimeOffRequestsApproveChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Approve/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequestsApproveChild" ], "operationId": "TimeOffRequestsApproveChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffRequests": { "get": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[TimeOffRequestModel,TimeOffRequest]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeOffRequestModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeOffRequestModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeOffRequestModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffRequests/{id}": { "get": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[TimeOffRequestModel,TimeOffRequest]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffRequests/entityInformation": { "get": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffRequests/entityInformation/fields": { "get": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/Resources/{parentId}/TimeOffRequests/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequestsChild" ], "operationId": "TimeOffRequestsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsReject/entityInformation": { "get": { "tags": [ "TimeOffRequestsReject" ], "operationId": "TimeOffRequestsReject_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsReject/entityInformation/fields": { "get": { "tags": [ "TimeOffRequestsReject" ], "operationId": "TimeOffRequestsReject_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequestsReject/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequestsReject" ], "operationId": "TimeOffRequestsReject_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Reject": { "post": { "tags": [ "TimeOffRequestsRejectChild" ], "operationId": "TimeOffRequestsRejectChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TimeOffRequestRejectModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Reject/entityInformation": { "get": { "tags": [ "TimeOffRequestsRejectChild" ], "operationId": "TimeOffRequestsRejectChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Reject/entityInformation/fields": { "get": { "tags": [ "TimeOffRequestsRejectChild" ], "operationId": "TimeOffRequestsRejectChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/TimeOffRequests/{parentId}/Reject/entityInformation/userDefinedFields": { "get": { "tags": [ "TimeOffRequestsRejectChild" ], "operationId": "TimeOffRequestsRejectChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/query": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[UserDefinedFieldDefinitionModel,UserDefinedFieldDefinition]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[UserDefinedFieldDefinitionModel,UserDefinedFieldDefinition]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/{id}": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[UserDefinedFieldDefinitionModel,UserDefinedFieldDefinition]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/query/count": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions": { "put": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldDefinitionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldDefinitionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldDefinitionModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/entityInformation": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/entityInformation/fields": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldDefinitions/entityInformation/userDefinedFields": { "get": { "tags": [ "UserDefinedFieldDefinitions" ], "operationId": "UserDefinedFieldDefinitions_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/query": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[UserDefinedFieldListItemModel,UserDefinedFieldListItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[UserDefinedFieldListItemModel,UserDefinedFieldListItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/{id}": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[UserDefinedFieldListItemModel,UserDefinedFieldListItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/query/count": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/entityInformation": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/entityInformation/fields": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFieldListItems/entityInformation/userDefinedFields": { "get": { "tags": [ "UserDefinedFieldListItems" ], "operationId": "UserDefinedFieldListItems_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFields/{parentId}/ListItems": { "get": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[UserDefinedFieldListItemModel,UserDefinedFieldListItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldListItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldListItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDefinedFieldListItemModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFields/{parentId}/ListItems/{id}": { "get": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[UserDefinedFieldListItemModel,UserDefinedFieldListItem]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFields/{parentId}/ListItems/entityInformation": { "get": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFields/{parentId}/ListItems/entityInformation/fields": { "get": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/UserDefinedFields/{parentId}/ListItems/entityInformation/userDefinedFields": { "get": { "tags": [ "UserDefinedFieldListItemsChild" ], "operationId": "UserDefinedFieldListItemsChild_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "parentId", "in": "path", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/query": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[WebhookEventErrorLogModel,WebhookEventErrorLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[WebhookEventErrorLogModel,WebhookEventErrorLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/{id}": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[WebhookEventErrorLogModel,WebhookEventErrorLog]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_DeleteEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/query/count": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/entityInformation": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/entityInformation/fields": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WebhookEventErrorLogs/entityInformation/userDefinedFields": { "get": { "tags": [ "WebhookEventErrorLogs" ], "operationId": "WebhookEventErrorLogs_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/query": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_UrlParameterQuery", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[WorkTypeModifierModel,WorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_Query", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryActionResult[WorkTypeModifierModel,WorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/{id}": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_QueryItem", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemQueryResultModel[WorkTypeModifierModel,WorkTypeModifier]" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/query/count": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_UrlParameterQueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_QueryCount", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "queryModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryCountResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers": { "put": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WorkTypeModifierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WorkTypeModifierModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/entityInformation": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_QueryEntityInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EntityInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/entityInformation/fields": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_QueryFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/WorkTypeModifiers/entityInformation/userDefinedFields": { "get": { "tags": [ "WorkTypeModifiers" ], "operationId": "WorkTypeModifiers_QueryUserDefinedFieldDefinitions", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDefinedFieldInformationResultModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ZoneInformation": { "get": { "tags": [ "ZoneInformationApiIntegration" ], "operationId": "ZoneInformationApiIntegration_QueryZoneInformation", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "user", "in": "query", "required": true, "type": "string" }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZoneInformationResultModel" } } } } } }, "definitions": { "UpdateAccountInvoiceSettingsModel": { "type": "object", "properties": { "taxExempt": { "type": "boolean" }, "taxRegionId": { "format": "int32", "type": "integer" }, "taxId": { "type": "string" }, "invoiceEmailingEnabled": { "type": "boolean" }, "otherEmails": { "type": "string" } } }, "OperationActionResult": { "type": "object", "properties": {} }, "UpdateContactRecipientsModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "UpdateResourceRecipientsModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "QueryModel": { "type": "object", "properties": { "maxRecords": { "format": "int32", "type": "integer" }, "includeFields": { "type": "array", "items": { "type": "string" } }, "filter": { "type": "array", "items": { "$ref": "#/definitions/Filter" } } }, "example": { "MaxRecords": 10, "IncludeFields": [], "Filter": [ { "op": "gt", "field": "id", "value": 0, "udf": false, "items": [] } ] } }, "QueryActionResult[ActionTypeModel,ActionType]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ActionTypeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CountActionResult": { "type": "object", "properties": {} }, "ActionTypeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "isSystemActionType": { "type": "boolean" }, "view": { "format": "int32", "type": "integer" } } }, "UserDefinedField": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "QueryActionResult[AdditionalInvoiceFieldValueModel,AdditionalInvoiceFieldValue]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/AdditionalInvoiceFieldValueModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "AemMoveInstalledProductModel": { "type": "object", "properties": { "oldConfigurationItemID": { "format": "int32", "type": "integer" }, "newCompanyID": { "format": "int32", "type": "integer" } } }, "AemProcessAlertModel": { "type": "object", "properties": { "ticketEntity": { "$ref": "#/definitions/TicketModel" }, "alertTime": { "format": "date-time", "type": "string" }, "alertDetail": { "type": "string" }, "repeatingThresholdInMinutes": { "format": "int32", "type": "integer" }, "relatedThresholdInMinutes": { "format": "int32", "type": "integer" }, "isCreateAlertTicketEnabled": { "type": "boolean" }, "isCreateRelatedTicketNoteEnabled": { "type": "boolean" }, "openAlertCount": { "format": "int32", "type": "integer" } } }, "TicketModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "apiVendorID": { "format": "int32", "type": "integer" }, "assignedResourceID": { "format": "int32", "type": "integer" }, "assignedResourceRoleID": { "format": "int32", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "changeApprovalBoard": { "format": "int32", "type": "integer" }, "changeApprovalStatus": { "format": "int32", "type": "integer" }, "changeApprovalType": { "format": "int32", "type": "integer" }, "changeInfoField1": { "type": "string" }, "changeInfoField2": { "type": "string" }, "changeInfoField3": { "type": "string" }, "changeInfoField4": { "type": "string" }, "changeInfoField5": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyLocationID": { "format": "int32", "type": "integer" }, "completedByResourceID": { "format": "int32", "type": "integer" }, "completedDate": { "format": "date-time", "type": "string" }, "configurationItemID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int64", "type": "integer" }, "contractServiceID": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "createdByContactID": { "format": "int32", "type": "integer" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "creatorType": { "format": "int32", "type": "integer" }, "currentServiceThermometerRating": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "dueDateTime": { "format": "date-time", "type": "string" }, "estimatedHours": { "format": "double", "type": "number" }, "externalID": { "type": "string" }, "firstResponseAssignedResourceID": { "format": "int32", "type": "integer" }, "firstResponseDateTime": { "format": "date-time", "type": "string" }, "firstResponseDueDateTime": { "format": "date-time", "type": "string" }, "firstResponseInitiatingResourceID": { "format": "int32", "type": "integer" }, "hoursToBeScheduled": { "format": "double", "type": "number" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "isAssignedToComanaged": { "type": "boolean" }, "issueType": { "format": "int32", "type": "integer" }, "isVisibleToComanaged": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastActivityPersonType": { "format": "int32", "type": "integer" }, "lastActivityResourceID": { "format": "int32", "type": "integer" }, "lastCustomerNotificationDateTime": { "format": "date-time", "type": "string" }, "lastCustomerVisibleActivityDateTime": { "format": "date-time", "type": "string" }, "lastTrackedModificationDateTime": { "format": "date-time", "type": "string" }, "monitorID": { "format": "int64", "type": "integer" }, "monitorTypeID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "previousServiceThermometerRating": { "format": "int32", "type": "integer" }, "priority": { "format": "int32", "type": "integer" }, "problemTicketId": { "format": "int32", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "queueID": { "format": "int32", "type": "integer" }, "resolution": { "type": "string" }, "resolutionPlanDateTime": { "format": "date-time", "type": "string" }, "resolutionPlanDueDateTime": { "format": "date-time", "type": "string" }, "resolvedDateTime": { "format": "date-time", "type": "string" }, "resolvedDueDateTime": { "format": "date-time", "type": "string" }, "rmaStatus": { "format": "int32", "type": "integer" }, "rmaType": { "format": "int32", "type": "integer" }, "rmmAlertID": { "type": "string" }, "serviceLevelAgreementHasBeenMet": { "type": "boolean" }, "serviceLevelAgreementID": { "format": "int32", "type": "integer" }, "serviceLevelAgreementPausedNextEventHours": { "format": "double", "type": "number" }, "serviceThermometerTemperature": { "format": "int32", "type": "integer" }, "source": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "subIssueType": { "format": "int32", "type": "integer" }, "ticketCategory": { "format": "int32", "type": "integer" }, "ticketNumber": { "type": "string" }, "ticketType": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "AemProcessResolveAlertTicketModel": { "type": "object", "properties": { "alertId": { "type": "string" }, "selfHealStatusId": { "format": "int32", "type": "integer" }, "clearStatusId": { "format": "int32", "type": "integer" }, "openAlertCount": { "format": "int32", "type": "integer" }, "ticketId": { "format": "int32", "type": "integer" } } }, "AemUnregisterUserModel": { "type": "object", "properties": { "aemSaml": { "type": "string" }, "psaUserId": { "format": "int32", "type": "integer" } } }, "AemRegisterUserModel": { "type": "object", "properties": { "aemSaml": { "type": "string" }, "psaSaml": { "type": "string" } } }, "AemRegisterInstanceModel": { "type": "object", "properties": { "aemInstanceId": { "type": "string" }, "aemUrl": { "type": "string" } } }, "AemUnregisterInstanceModel": { "type": "object", "properties": { "aemSaml": { "type": "string" } } }, "QueryActionResult[AppointmentModel,Appointment]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/AppointmentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "AppointmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "resourceID": { "format": "int32", "type": "integer" }, "startDateTime": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "updateDateTime": { "format": "date-time", "type": "string" } } }, "ArticleAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "Expression[Func[AttachmentInfo,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ParameterExpression": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "Expression": { "type": "object", "properties": { "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleConfigurationItemCategoryAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleConfigurationItemCategoryAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "installedProductCategoryID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleInstalledProductCategoryAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleInstalledProductCategoryAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleNoteModel,ArticleNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createdDateTime": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "articleID": { "format": "int32", "type": "integer" }, "lastModifiedByResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleNote,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticlePlainTextContentModel,ArticlePlainTextContent]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticlePlainTextContentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticlePlainTextContentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contentData": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticlePlainTextContent,Int64]]", "readOnly": true } } }, "Expression[Func[ArticlePlainTextContent,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleTagAssociationModel,ArticleTagAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleTagAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleTagAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "tagID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleTagAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleTagAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleTicketAssociationModel,ArticleTicketAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleTicketAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleTicketAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleTicketAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleTicketAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleToArticleAssociationModel,ArticleToArticleAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleToArticleAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleToArticleAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "associatedArticleID": { "format": "int32", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleToArticleAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleToArticleAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ArticleToDocumentAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ArticleToDocumentAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "associatedDocumentID": { "format": "int32", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ArticleToDocumentAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ArticleToDocumentAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[AttachmentInfoModel,AttachmentInfo]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/AttachmentInfoModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[BillingCodeModel,AllocationCode]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BillingCodeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[BillingItemApprovalLevelModel,BillingItemApprovalLevel]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BillingItemApprovalLevelModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "BillingItemApprovalLevelModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approvalDateTime": { "format": "date-time", "type": "string" }, "approvalLevel": { "format": "int32", "type": "integer" }, "approvalResourceID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[BillingItemModel,BillingItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/BillingItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "BillingItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "accountManagerWhenApprovedID": { "format": "int32", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "taxCategoryID": { "format": "int32", "type": "integer" }, "billingItemType": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "configurationItemID": { "format": "int64", "type": "integer" }, "contractBlockID": { "format": "int32", "type": "integer" }, "contractChargeID": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceAdjustmentID": { "format": "int32", "type": "integer" }, "contractServiceBundleAdjustmentID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "contractServiceBundlePeriodID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "contractServicePeriodID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "expenseItemID": { "format": "int32", "type": "integer" }, "extendedPrice": { "format": "double", "type": "number" }, "internalCurrencyExtendedPrice": { "format": "double", "type": "number" }, "internalCurrencyRate": { "format": "double", "type": "number" }, "internalCurrencyTaxDollars": { "format": "double", "type": "number" }, "internalCurrencyTotalAmount": { "format": "double", "type": "number" }, "invoiceID": { "format": "int32", "type": "integer" }, "itemApproverID": { "format": "int32", "type": "integer" }, "itemDate": { "format": "date-time", "type": "string" }, "itemName": { "type": "string" }, "lineItemFullDescription": { "type": "string" }, "lineItemGroupDescription": { "type": "string" }, "milestoneID": { "format": "int64", "type": "integer" }, "nonBillable": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "ourCost": { "format": "double", "type": "number" }, "postedDate": { "format": "date-time", "type": "string" }, "postedOnTime": { "format": "date-time", "type": "string" }, "projectChargeID": { "format": "int64", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "quantity": { "format": "double", "type": "number" }, "rate": { "format": "double", "type": "number" }, "roleID": { "format": "int32", "type": "integer" }, "serviceBundleID": { "format": "int64", "type": "integer" }, "serviceID": { "format": "int64", "type": "integer" }, "sortOrderID": { "format": "int64", "type": "integer" }, "subType": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "taxDollars": { "format": "double", "type": "number" }, "ticketChargeID": { "format": "int64", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" }, "totalAmount": { "format": "double", "type": "number" }, "vendorID": { "format": "int64", "type": "integer" }, "webServiceDate": { "format": "date-time", "type": "string" } } }, "QueryActionResult[ChangeOrderChargeModel,ChangeOrderCost]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ChangeOrderChargeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ChangeOrderChargeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billableAmount": { "format": "double", "type": "number" }, "billingCodeID": { "format": "int32", "type": "integer" }, "changeOrderHours": { "format": "double", "type": "number" }, "chargeType": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "extendedCost": { "format": "double", "type": "number" }, "internalCurrencyBillableAmount": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalPurchaseOrderNumber": { "type": "string" }, "isBillableToCompany": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "statusLastModifiedBy": { "format": "int32", "type": "integer" }, "statusLastModifiedDate": { "format": "date-time", "type": "string" }, "taskID": { "format": "int32", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "unitQuantity": { "format": "double", "type": "number" } } }, "QueryActionResult[ChangeRequestLinkModel,ChangeRequestLink]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ChangeRequestLinkModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ChangeRequestLinkModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "changeRequestTicketID": { "format": "int32", "type": "integer" }, "problemOrIncidentTicketID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[ChecklistLibraryModel,ChecklistLibrary]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ChecklistLibraryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ChecklistLibraryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "entityType": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ChecklistLibraryChecklistItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ChecklistLibraryChecklistItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "checklistLibraryID": { "format": "int32", "type": "integer" }, "isImportant": { "type": "boolean" }, "itemName": { "type": "string" }, "knowledgebaseArticleID": { "format": "int32", "type": "integer" }, "position": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ChecklistLibraryChecklistItem,Int64]]", "readOnly": true } } }, "Expression[Func[ChecklistLibraryChecklistItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ClassificationIconModel,ClassificationIcon]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ClassificationIconModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ClientPortalUserModel,ClientPortalUser]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ClientPortalUserModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ClientPortalUserModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "dateFormat": { "format": "int32", "type": "integer" }, "isClientPortalActive": { "type": "boolean" }, "numberFormat": { "format": "int32", "type": "integer" }, "password": { "type": "string" }, "securityLevel": { "format": "int32", "type": "integer" }, "timeFormat": { "format": "int32", "type": "integer" }, "userName": { "type": "string" } } }, "QueryActionResult[ComanagedAssociationModel,ComanagedAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ComanagedAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ComanagedAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "isPrimaryComanagedResource": { "type": "boolean" }, "resourceID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[CompanyModel,Account]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalAddressInformation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "alternatePhone1": { "type": "string" }, "alternatePhone2": { "type": "string" }, "apiVendorID": { "format": "int32", "type": "integer" }, "assetValue": { "format": "double", "type": "number" }, "billToCompanyLocationID": { "format": "int32", "type": "integer" }, "billToAdditionalAddressInformation": { "type": "string" }, "billingAddress1": { "type": "string" }, "billingAddress2": { "type": "string" }, "billToAddressToUse": { "format": "int32", "type": "integer" }, "billToAttention": { "type": "string" }, "billToCity": { "type": "string" }, "billToCountryID": { "format": "int32", "type": "integer" }, "billToState": { "type": "string" }, "billToZipCode": { "type": "string" }, "city": { "type": "string" }, "classification": { "format": "int32", "type": "integer" }, "companyCategoryID": { "format": "int32", "type": "integer" }, "companyName": { "type": "string" }, "companyNumber": { "type": "string" }, "companyType": { "format": "int32", "type": "integer" }, "competitorID": { "format": "int32", "type": "integer" }, "countryID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "fax": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "invoiceEmailMessageID": { "format": "int32", "type": "integer" }, "invoiceMethod": { "format": "int32", "type": "integer" }, "invoiceNonContractItemsToParentCompany": { "type": "boolean" }, "invoiceTemplateID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isClientPortalActive": { "type": "boolean" }, "isEnabledForComanaged": { "type": "boolean" }, "isSample": { "type": "boolean" }, "isTaskFireActive": { "type": "boolean" }, "isTaxExempt": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastTrackedModifiedDateTime": { "format": "date-time", "type": "string" }, "marketSegmentID": { "format": "int32", "type": "integer" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "parentCompanyID": { "format": "int32", "type": "integer" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "purchaseOrderTemplateID": { "format": "int32", "type": "integer" }, "quoteEmailMessageID": { "format": "int32", "type": "integer" }, "quoteTemplateID": { "format": "int32", "type": "integer" }, "sicCode": { "type": "string" }, "state": { "type": "string" }, "stockMarket": { "type": "string" }, "stockSymbol": { "type": "string" }, "surveyCompanyRating": { "format": "double", "type": "number" }, "taxID": { "type": "string" }, "taxRegionID": { "format": "int32", "type": "integer" }, "territoryID": { "format": "int32", "type": "integer" }, "webAddress": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[CompanyAlertModel,AccountAlert]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyAlertModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyAlertModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "alertText": { "type": "string" }, "alertTypeID": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountAlert,Int64]]", "readOnly": true } } }, "Expression[Func[AccountAlert,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "CompanyAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyNoteID": { "format": "int32", "type": "integer" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "salesOrderID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyCategoryModel,AccountCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "displayColorRGB": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isApiOnly": { "type": "boolean" }, "isGlobalDefault": { "type": "boolean" }, "name": { "type": "string" }, "nickname": { "type": "string" } } }, "QueryActionResult[ContactModel,Contact]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalAddressInformation": { "type": "string" }, "addressLine": { "type": "string" }, "addressLine1": { "type": "string" }, "alternatePhone": { "type": "string" }, "apiVendorID": { "format": "int32", "type": "integer" }, "bulkEmailOptOutTime": { "format": "date-time", "type": "string" }, "city": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyLocationID": { "format": "int32", "type": "integer" }, "countryID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "emailAddress": { "type": "string" }, "emailAddress2": { "type": "string" }, "emailAddress3": { "type": "string" }, "extension": { "type": "string" }, "externalID": { "type": "string" }, "facebookUrl": { "type": "string" }, "faxNumber": { "type": "string" }, "firstName": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "isActive": { "format": "int32", "type": "integer" }, "isOptedOutFromBulkEmail": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastModifiedDate": { "format": "date-time", "type": "string" }, "lastName": { "type": "string" }, "linkedInUrl": { "type": "string" }, "middleInitial": { "type": "string" }, "mobilePhone": { "type": "string" }, "namePrefix": { "format": "int32", "type": "integer" }, "nameSuffix": { "format": "int32", "type": "integer" }, "note": { "type": "string" }, "receivesEmailNotifications": { "type": "boolean" }, "phone": { "type": "string" }, "primaryContact": { "type": "boolean" }, "billingContact": { "type": "boolean" }, "roomNumber": { "type": "string" }, "solicitationOptOut": { "type": "boolean" }, "solicitationOptOutTime": { "format": "date-time", "type": "string" }, "state": { "type": "string" }, "surveyOptOut": { "type": "boolean" }, "title": { "type": "string" }, "twitterUrl": { "type": "string" }, "zipCode": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[Contact,Int64]]", "readOnly": true }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[Contact,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyLocationModel,AccountPhysicalLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyLocationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyLocationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "alternatePhone1": { "type": "string" }, "alternatePhone2": { "type": "string" }, "city": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "countryID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "fax": { "type": "string" }, "isActive": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "isTaxExempt": { "type": "boolean" }, "overrideCompanyTaxSettings": { "type": "boolean" }, "name": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "roundtripDistance": { "format": "double", "type": "number" }, "state": { "type": "string" }, "taxRegionID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountPhysicalLocation,Int64]]", "readOnly": true } } }, "Expression[Func[AccountPhysicalLocation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "CompanyNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyNoteID": { "format": "int32", "type": "integer" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "salesOrderID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyNoteModel,AccountNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "actionType": { "format": "int32", "type": "integer" }, "assignedResourceID": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "completedDateTime": { "format": "date-time", "type": "string" }, "contactID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDate": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "note": { "type": "string" }, "opportunityID": { "format": "int32", "type": "integer" }, "startDateTime": { "format": "date-time", "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountNote,Int64]]", "readOnly": true } } }, "Expression[Func[AccountNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanySiteConfigurationModel,AccountLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanySiteConfigurationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanySiteConfigurationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "locationName": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountLocation,Int64]]", "readOnly": true }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountLocation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyTeamModel,AccountTeam]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyTeamModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyTeamModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int64", "type": "integer" }, "isAssociatedAsComanaged": { "type": "boolean" }, "resourceID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountTeam,Int64]]", "readOnly": true } } }, "Expression[Func[AccountTeam,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyToDoModel,AccountToDo]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyToDoModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyToDoModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "actionType": { "format": "int32", "type": "integer" }, "activityDescription": { "type": "string" }, "assignedToResourceID": { "format": "int64", "type": "integer" }, "companyID": { "format": "int64", "type": "integer" }, "completedDate": { "format": "date-time", "type": "string" }, "contactID": { "format": "int64", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int64", "type": "integer" }, "endDateTime": { "format": "date-time", "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDate": { "format": "date-time", "type": "string" }, "opportunityID": { "format": "int64", "type": "integer" }, "startDateTime": { "format": "date-time", "type": "string" }, "ticketID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountToDo,Int64]]", "readOnly": true } } }, "Expression[Func[AccountToDo,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyWebhookExcludedResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyWebhookExcludedResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountWebhookExcludedResource,Int64]]", "readOnly": true } } }, "Expression[Func[AccountWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyWebhookFieldModel,AccountWebhookField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyWebhookFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyWebhookFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fieldID": { "format": "int32", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountWebhookField,Int64]]", "readOnly": true } } }, "Expression[Func[AccountWebhookField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CompanyWebhookModel,AccountWebhook]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyWebhookModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyWebhookModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "deactivationUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isReady": { "type": "boolean" }, "isSubscribedToCreateEvents": { "type": "boolean" }, "isSubscribedToDeleteEvents": { "type": "boolean" }, "isSubscribedToUpdateEvents": { "type": "boolean" }, "name": { "type": "string" }, "notificationEmailAddress": { "type": "string" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "secretKey": { "type": "string" }, "sendThresholdExceededNotification": { "type": "boolean" }, "webhookGUID": { "type": "string" }, "webhookUrl": { "type": "string" } } }, "QueryActionResult[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CompanyWebhookUdfFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CompanyWebhookUdfFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "udfFieldID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AccountWebhookUdfField,Int64]]", "readOnly": true } } }, "Expression[Func[AccountWebhookUdfField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ConfigurationItemAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "configurationItemID": { "format": "int32", "type": "integer" }, "configurationItemNoteID": { "format": "int32", "type": "integer" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemBillingProductAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemBillingProductAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingProductID": { "format": "int32", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "effectiveDate": { "format": "date-time", "type": "string" }, "expirationDate": { "format": "date-time", "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductBillingProductAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductBillingProductAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemCategoryModel,InstalledProductCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "displayColorRGB": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isClientPortalDefault": { "type": "boolean" }, "isGlobalDefault": { "type": "boolean" }, "name": { "type": "string" }, "nickname": { "type": "string" } } }, "QueryActionResult[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemCategoryUdfAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemCategoryUdfAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemCategoryID": { "format": "int32", "type": "integer" }, "isRequired": { "type": "boolean" }, "userDefinedFieldDefinitionID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductCategoryUdfAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductCategoryUdfAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemDnsRecordModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemExtModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "apiVendorID": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "companyLocationID": { "format": "int32", "type": "integer" }, "configurationItemCategoryID": { "format": "int32", "type": "integer" }, "configurationItemType": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "createdByPersonID": { "format": "int32", "type": "integer" }, "dailyCost": { "format": "double", "type": "number" }, "dattoAvailableKilobytes": { "format": "int64", "type": "integer" }, "dattoDeviceMemoryMegabytes": { "format": "int32", "type": "integer" }, "dattoDrivesErrors": { "type": "boolean" }, "dattoHostname": { "type": "string" }, "dattoInternalIP": { "type": "string" }, "dattoKernelVersionID": { "type": "string" }, "dattoLastCheckInDateTime": { "format": "date-time", "type": "string" }, "dattoNICSpeedKilobitsPerSecond": { "format": "int32", "type": "integer" }, "dattoNumberOfAgents": { "format": "int32", "type": "integer" }, "dattoNumberOfDrives": { "format": "int32", "type": "integer" }, "dattoNumberOfVolumes": { "format": "int32", "type": "integer" }, "dattoOffsiteUsedBytes": { "format": "int64", "type": "integer" }, "dattoOSVersionID": { "type": "string" }, "dattoPercentageUsed": { "format": "double", "type": "number" }, "dattoProtectedKilobytes": { "format": "int64", "type": "integer" }, "dattoRemoteIP": { "type": "string" }, "dattoSerialNumber": { "type": "string" }, "dattoUptimeSeconds": { "format": "int32", "type": "integer" }, "dattoUsedKilobytes": { "format": "int64", "type": "integer" }, "dattoZFSVersionID": { "type": "string" }, "deviceNetworkingID": { "type": "string" }, "domain": { "type": "string" }, "domainRegistrarID": { "format": "int32", "type": "integer" }, "domainRegistrationDateTime": { "format": "date-time", "type": "string" }, "domainLastUpdatedDateTime": { "format": "date-time", "type": "string" }, "domainExpirationDateTime": { "format": "date-time", "type": "string" }, "hourlyCost": { "format": "double", "type": "number" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "installDate": { "format": "date-time", "type": "string" }, "installedByContactID": { "format": "int32", "type": "integer" }, "installedByID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "lastActivityPersonID": { "format": "int32", "type": "integer" }, "lastActivityPersonType": { "format": "int32", "type": "integer" }, "lastModifiedTime": { "format": "date-time", "type": "string" }, "location": { "type": "string" }, "monthlyCost": { "format": "double", "type": "number" }, "notes": { "type": "string" }, "numberOfUsers": { "format": "double", "type": "number" }, "parentConfigurationItemID": { "format": "int32", "type": "integer" }, "perUseCost": { "format": "double", "type": "number" }, "productID": { "format": "int32", "type": "integer" }, "referenceNumber": { "type": "string" }, "referenceTitle": { "type": "string" }, "rmmDeviceAuditAntivirusStatusID": { "type": "string" }, "rmmDeviceAuditArchitectureID": { "type": "string" }, "rmmDeviceAuditBackupStatusID": { "type": "string" }, "rmmDeviceAuditDescription": { "type": "string" }, "rmmDeviceAuditDeviceTypeID": { "type": "string" }, "rmmDeviceAuditDisplayAdaptorID": { "type": "string" }, "rmmDeviceAuditDomainID": { "type": "string" }, "rmmDeviceAuditExternalIPAddress": { "type": "string" }, "rmmDeviceAuditHostname": { "type": "string" }, "rmmDeviceAuditIPAddress": { "type": "string" }, "rmmDeviceAuditLastUser": { "type": "string" }, "rmmDeviceAuditMacAddress": { "type": "string" }, "rmmDeviceAuditManufacturerID": { "type": "string" }, "rmmDeviceAuditFirmwareID": { "type": "string" }, "rmmDeviceAuditMemoryBytes": { "format": "int64", "type": "integer" }, "rmmDeviceAuditMissingPatchCount": { "format": "int32", "type": "integer" }, "rmmDeviceAuditMobileNetworkOperatorID": { "type": "string" }, "rmmDeviceAuditMobileNumber": { "type": "string" }, "rmmDeviceAuditModelID": { "type": "string" }, "rmmDeviceAuditMotherboardID": { "type": "string" }, "rmmDeviceAuditOperatingSystemID": { "type": "string" }, "rmmDeviceAuditOperatingSystemNameID": { "type": "string" }, "rmmDeviceAuditOperatingSystemVersionID": { "type": "string" }, "rmmDeviceAuditPatchStatusID": { "type": "string" }, "rmmDeviceAuditProcessorID": { "type": "string" }, "rmmDeviceAuditServicePackID": { "type": "string" }, "rmmDeviceAuditSNMPContact": { "type": "string" }, "rmmDeviceAuditSNMPLocation": { "type": "string" }, "rmmDeviceAuditSNMPName": { "type": "string" }, "rmmDeviceAuditSoftwareStatusID": { "type": "string" }, "rmmDeviceAuditStorageBytes": { "format": "int64", "type": "integer" }, "rmmDeviceID": { "format": "int64", "type": "integer" }, "rmmDeviceUID": { "type": "string" }, "rmmVsaxDeviceID": { "type": "string" }, "rmmOpenAlertCount": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "serviceLevelAgreementID": { "format": "int32", "type": "integer" }, "setupFee": { "format": "double", "type": "number" }, "sourceChargeID": { "format": "int32", "type": "integer" }, "sourceChargeType": { "format": "int32", "type": "integer" }, "sslSource": { "type": "string" }, "sslCommonName": { "type": "string" }, "sslValidFromDateTime": { "format": "date-time", "type": "string" }, "sslValidUntilDateTime": { "format": "date-time", "type": "string" }, "sslIssuedBy": { "type": "string" }, "sslOrganization": { "type": "string" }, "sslOrganizationUnit": { "type": "string" }, "sslLocation": { "type": "string" }, "sslSerialNumber": { "type": "string" }, "sslSignatureAlgorithm": { "type": "string" }, "vendorID": { "format": "int32", "type": "integer" }, "warrantyExpirationDate": { "format": "date-time", "type": "string" }, "rmmIsInMaintenanceMode": { "type": "boolean" }, "rmmIsMobileDeviceManagementEnrolled": { "type": "boolean" }, "rmmDeviceUrl": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ConfigurationItemNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "configurationItemID": { "format": "int32", "type": "integer" }, "configurationItemNoteID": { "format": "int32", "type": "integer" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemNoteModel,InstalledProductNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "noteType": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductNote,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemRelatedItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemRelatedItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "relatedConfigurationItemID": { "format": "int32", "type": "integer" }, "relationship": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductRelatedItem,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductRelatedItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemModel,InstalledProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "apiVendorID": { "format": "int32", "type": "integer" }, "configurationItemCategoryID": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "companyLocationID": { "format": "int32", "type": "integer" }, "configurationItemType": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "createdByPersonID": { "format": "int32", "type": "integer" }, "dailyCost": { "format": "double", "type": "number" }, "dattoAvailableKilobytes": { "format": "int64", "type": "integer" }, "dattoDeviceMemoryMegabytes": { "format": "int32", "type": "integer" }, "dattoDrivesErrors": { "type": "boolean" }, "dattoHostname": { "type": "string" }, "dattoInternalIP": { "type": "string" }, "dattoKernelVersionID": { "format": "int32", "type": "integer" }, "dattoLastCheckInDateTime": { "format": "date-time", "type": "string" }, "dattoNICSpeedKilobitsPerSecond": { "format": "int32", "type": "integer" }, "dattoNumberOfAgents": { "format": "int32", "type": "integer" }, "dattoNumberOfDrives": { "format": "int32", "type": "integer" }, "dattoNumberOfVolumes": { "format": "int32", "type": "integer" }, "dattoOffsiteUsedBytes": { "format": "int64", "type": "integer" }, "dattoOSVersionID": { "format": "int32", "type": "integer" }, "dattoPercentageUsed": { "format": "double", "type": "number" }, "dattoProtectedKilobytes": { "format": "int64", "type": "integer" }, "dattoRemoteIP": { "type": "string" }, "dattoSerialNumber": { "type": "string" }, "dattoUptimeSeconds": { "format": "int32", "type": "integer" }, "dattoUsedKilobytes": { "format": "int64", "type": "integer" }, "dattoZFSVersionID": { "format": "int32", "type": "integer" }, "deviceNetworkingID": { "type": "string" }, "domain": { "type": "string" }, "domainRegistrarID": { "format": "int32", "type": "integer" }, "domainRegistrationDateTime": { "format": "date-time", "type": "string" }, "domainLastUpdatedDateTime": { "format": "date-time", "type": "string" }, "domainExpirationDateTime": { "format": "date-time", "type": "string" }, "hourlyCost": { "format": "double", "type": "number" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "installDate": { "format": "date-time", "type": "string" }, "installedByContactID": { "format": "int32", "type": "integer" }, "installedByID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "lastActivityPersonID": { "format": "int32", "type": "integer" }, "lastActivityPersonType": { "format": "int32", "type": "integer" }, "lastModifiedTime": { "format": "date-time", "type": "string" }, "location": { "type": "string" }, "monthlyCost": { "format": "double", "type": "number" }, "notes": { "type": "string" }, "numberOfUsers": { "format": "double", "type": "number" }, "parentConfigurationItemID": { "format": "int32", "type": "integer" }, "perUseCost": { "format": "double", "type": "number" }, "productID": { "format": "int32", "type": "integer" }, "referenceNumber": { "type": "string" }, "referenceTitle": { "type": "string" }, "rmmDeviceAuditAntivirusStatusID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditArchitectureID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditBackupStatusID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditDescription": { "type": "string" }, "rmmDeviceAuditDeviceTypeID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditDisplayAdaptorID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditDomainID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditExternalIPAddress": { "type": "string" }, "rmmDeviceAuditHostname": { "type": "string" }, "rmmDeviceAuditIPAddress": { "type": "string" }, "rmmDeviceAuditLastUser": { "type": "string" }, "rmmDeviceAuditMacAddress": { "type": "string" }, "rmmDeviceAuditManufacturerID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditFirmwareID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditMemoryBytes": { "format": "int64", "type": "integer" }, "rmmDeviceAuditMissingPatchCount": { "format": "int32", "type": "integer" }, "rmmDeviceAuditMobileNetworkOperatorID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditMobileNumber": { "type": "string" }, "rmmDeviceAuditModelID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditMotherboardID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditOperatingSystem": { "type": "string" }, "rmmDeviceAuditPatchStatusID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditProcessorID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditServicePackID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditSNMPContact": { "type": "string" }, "rmmDeviceAuditSNMPLocation": { "type": "string" }, "rmmDeviceAuditSNMPName": { "type": "string" }, "rmmDeviceAuditSoftwareStatusID": { "format": "int32", "type": "integer" }, "rmmDeviceAuditStorageBytes": { "format": "int64", "type": "integer" }, "rmmDeviceID": { "format": "int64", "type": "integer" }, "rmmDeviceUID": { "type": "string" }, "rmmVsaxDeviceID": { "type": "string" }, "rmmOpenAlertCount": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "serviceLevelAgreementID": { "format": "int32", "type": "integer" }, "setupFee": { "format": "double", "type": "number" }, "sourceChargeID": { "format": "int32", "type": "integer" }, "sourceChargeType": { "format": "int32", "type": "integer" }, "sslSource": { "type": "string" }, "sslCommonName": { "type": "string" }, "sslValidFromDateTime": { "format": "date-time", "type": "string" }, "sslValidUntilDateTime": { "format": "date-time", "type": "string" }, "sslIssuedBy": { "type": "string" }, "sslOrganization": { "type": "string" }, "sslOrganizationUnit": { "type": "string" }, "sslLocation": { "type": "string" }, "sslSerialNumber": { "type": "string" }, "sslSignatureAlgorithm": { "type": "string" }, "vendorID": { "format": "int32", "type": "integer" }, "warrantyExpirationDate": { "format": "date-time", "type": "string" }, "rmmIsInMaintenanceMode": { "type": "boolean" }, "rmmIsMobileDeviceManagementEnrolled": { "type": "boolean" }, "rmmDeviceUrl": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemSslSubjectAlternativeNameModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ConfigurationItemTypeModel,InstalledProductType]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemTypeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemTypeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemWebhookExcludedResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemWebhookExcludedResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductWebhookExcludedResource,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemWebhookFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemWebhookFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fieldID": { "format": "int32", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductWebhookField,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductWebhookField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ConfigurationItemWebhookModel,InstalledProductWebhook]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemWebhookModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemWebhookModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "deactivationUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isReady": { "type": "boolean" }, "isSubscribedToCreateEvents": { "type": "boolean" }, "isSubscribedToDeleteEvents": { "type": "boolean" }, "isSubscribedToUpdateEvents": { "type": "boolean" }, "name": { "type": "string" }, "notificationEmailAddress": { "type": "string" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "secretKey": { "type": "string" }, "sendThresholdExceededNotification": { "type": "boolean" }, "webhookGUID": { "type": "string" }, "webhookUrl": { "type": "string" } } }, "QueryActionResult[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationItemWebhookUdfFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ConfigurationItemWebhookUdfFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "udfFieldID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InstalledProductWebhookUdfField,Int64]]", "readOnly": true } } }, "Expression[Func[InstalledProductWebhookUdfField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContactBillingProductAssociationModel,ContactBillingProductAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactBillingProductAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactBillingProductAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingProductID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "effectiveDate": { "format": "date-time", "type": "string" }, "expirationDate": { "format": "date-time", "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContactBillingProductAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[ContactBillingProductAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContactGroupContactModel,ContactGroupContact]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactGroupContactModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactGroupContactModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contactId": { "format": "int32", "type": "integer" }, "contactGroupId": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContactGroupContact,Int64]]", "readOnly": true } } }, "Expression[Func[ContactGroupContact,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContactGroupModel,ContactGroup]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactGroupModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactGroupModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "isActive": { "type": "boolean" } } }, "QueryActionResult[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactWebhookExcludedResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactWebhookExcludedResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContactWebhookExcludedResource,Int64]]", "readOnly": true } } }, "Expression[Func[ContactWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContactWebhookFieldModel,ContactWebhookField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactWebhookFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactWebhookFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fieldID": { "format": "int32", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContactWebhookField,Int64]]", "readOnly": true } } }, "Expression[Func[ContactWebhookField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContactWebhookModel,ContactWebhook]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactWebhookModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactWebhookModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "deactivationUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isReady": { "type": "boolean" }, "isSubscribedToCreateEvents": { "type": "boolean" }, "isSubscribedToDeleteEvents": { "type": "boolean" }, "isSubscribedToUpdateEvents": { "type": "boolean" }, "name": { "type": "string" }, "notificationEmailAddress": { "type": "string" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "secretKey": { "type": "string" }, "sendThresholdExceededNotification": { "type": "boolean" }, "webhookGUID": { "type": "string" }, "webhookUrl": { "type": "string" } } }, "QueryActionResult[ContactWebhookUdfFieldModel,ContactWebhookUdfField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContactWebhookUdfFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContactWebhookUdfFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "udfFieldID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContactWebhookUdfField,Int64]]", "readOnly": true } } }, "Expression[Func[ContactWebhookUdfField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractBillingRuleModel,ContractBillingRule]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractBillingRuleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractBillingRuleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "createChargesAsBillable": { "type": "boolean" }, "dailyProratedCost": { "format": "double", "type": "number" }, "dailyProratedPrice": { "format": "double", "type": "number" }, "determineUnits": { "format": "int32", "type": "integer" }, "endDate": { "format": "date-time", "type": "string" }, "executionMethod": { "format": "int32", "type": "integer" }, "includeItemsInChargeDescription": { "type": "boolean" }, "invoiceDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "isDailyProrationEnabled": { "type": "boolean" }, "maximumUnits": { "format": "int32", "type": "integer" }, "minimumUnits": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractBillingRule,Int64]]", "readOnly": true } } }, "Expression[Func[ContractBillingRule,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractBlockHourFactorModel,ContractFactor]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractBlockHourFactorModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractBlockHourFactorModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "blockHourMultiplier": { "format": "double", "type": "number" }, "contractHourlyRate": { "format": "double", "type": "number" }, "contractID": { "format": "int32", "type": "integer" }, "internalCurrencyContractHourlyRate": { "format": "double", "type": "number" }, "roleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractFactor,Int64]]", "readOnly": true } } }, "Expression[Func[ContractFactor,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractBlockModel,ContractBlock]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractBlockModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractBlockModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "hourlyRate": { "format": "double", "type": "number" }, "hours": { "format": "double", "type": "number" }, "hoursApproved": { "format": "double", "type": "number" }, "invoiceNumber": { "type": "string" }, "isPaid": { "type": "boolean" }, "paymentNumber": { "type": "string" }, "paymentType": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractBlock,Int64]]", "readOnly": true } } }, "Expression[Func[ContractBlock,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractChargeModel,ContractCost]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractChargeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractChargeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billableAmount": { "format": "double", "type": "number" }, "billingCodeID": { "format": "int64", "type": "integer" }, "chargeType": { "format": "int32", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "contractServiceBundleID": { "format": "int64", "type": "integer" }, "contractServiceID": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int64", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "extendedCost": { "format": "double", "type": "number" }, "internalCurrencyBillableAmount": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalPurchaseOrderNumber": { "type": "string" }, "isBillableToCompany": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "productID": { "format": "int64", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "status": { "format": "int64", "type": "integer" }, "statusLastModifiedBy": { "format": "int64", "type": "integer" }, "statusLastModifiedDate": { "format": "date-time", "type": "string" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "unitQuantity": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractCost,Int64]]", "readOnly": true } } }, "Expression[Func[ContractCost,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractExclusionBillingCodeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractExclusionBillingCodeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingCodeID": { "format": "int64", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractExclusionAllocationCode,Int64]]", "readOnly": true } } }, "Expression[Func[ContractExclusionAllocationCode,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractExclusionRoleModel,ContractExclusionRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractExclusionRoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractExclusionRoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "roleID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractExclusionRole,Int64]]", "readOnly": true } } }, "Expression[Func[ContractExclusionRole,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractExclusionSetExcludedRoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractExclusionSetExcludedRoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractExclusionSetID": { "format": "int32", "type": "integer" }, "excludedRoleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractExclusionSetExcludedRole,Int64]]", "readOnly": true } } }, "Expression[Func[ContractExclusionSetExcludedRole,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractExclusionSetExcludedWorkTypeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractExclusionSetExcludedWorkTypeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractExclusionSetID": { "format": "int32", "type": "integer" }, "excludedWorkTypeID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractExclusionSetExcludedWorkType,Int64]]", "readOnly": true } } }, "Expression[Func[ContractExclusionSetExcludedWorkType,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractExclusionSetModel,ContractExclusionSet]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractExclusionSetModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractExclusionSetModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[ContractMilestoneModel,ContractMilestone]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractMilestoneModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractMilestoneModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "amount": { "format": "double", "type": "number" }, "billingCodeID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "dateDue": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "internalCurrencyAmount": { "format": "double", "type": "number" }, "isInitialPayment": { "type": "boolean" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractMilestone,Int64]]", "readOnly": true } } }, "Expression[Func[ContractMilestone,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ContractNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "contractID": { "format": "int32", "type": "integer" }, "contractNoteID": { "format": "int32", "type": "integer" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractNoteModel,ContractNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractNote,Int64]]", "readOnly": true } } }, "Expression[Func[ContractNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractRateModel,ContractRate]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractRateModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractRateModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractHourlyRate": { "format": "double", "type": "number" }, "contractID": { "format": "int32", "type": "integer" }, "internalCurrencyContractHourlyRate": { "format": "double", "type": "number" }, "roleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractRate,Int64]]", "readOnly": true } } }, "Expression[Func[ContractRate,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractRetainerModel,ContractRetainer]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractRetainerModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractRetainerModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "amount": { "format": "double", "type": "number" }, "amountApproved": { "format": "double", "type": "number" }, "contractID": { "format": "int32", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "internalCurrencyAmount": { "format": "double", "type": "number" }, "internalCurrencyAmountApproved": { "format": "double", "type": "number" }, "invoiceNumber": { "type": "string" }, "isPaid": { "type": "boolean" }, "paymentID": { "format": "int32", "type": "integer" }, "paymentNumber": { "type": "string" }, "startDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractRetainer,Int64]]", "readOnly": true } } }, "Expression[Func[ContractRetainer,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractRoleCostModel,ContractRoleCost]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractRoleCostModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractRoleCostModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "rate": { "format": "double", "type": "number" }, "resourceID": { "format": "int32", "type": "integer" }, "roleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractRoleCost,Int64]]", "readOnly": true } } }, "Expression[Func[ContractRoleCost,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractModel,Contract]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingPreference": { "format": "int32", "type": "integer" }, "billToCompanyContactID": { "format": "int32", "type": "integer" }, "billToCompanyID": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "contactName": { "type": "string" }, "contractCategory": { "format": "int32", "type": "integer" }, "contractExclusionSetID": { "format": "int32", "type": "integer" }, "contractName": { "type": "string" }, "contractNumber": { "type": "string" }, "contractPeriodType": { "format": "int32", "type": "integer" }, "contractType": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "estimatedCost": { "format": "double", "type": "number" }, "estimatedHours": { "format": "double", "type": "number" }, "estimatedRevenue": { "format": "double", "type": "number" }, "exclusionContractID": { "format": "int64", "type": "integer" }, "internalCurrencyOverageBillingRate": { "format": "double", "type": "number" }, "internalCurrencySetupFee": { "format": "double", "type": "number" }, "isCompliant": { "type": "boolean" }, "isDefaultContract": { "type": "boolean" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "opportunityID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "overageBillingRate": { "format": "double", "type": "number" }, "purchaseOrderNumber": { "type": "string" }, "renewedContractID": { "format": "int64", "type": "integer" }, "serviceLevelAgreementID": { "format": "int32", "type": "integer" }, "setupFee": { "format": "double", "type": "number" }, "setupFeeBillingCodeID": { "format": "int64", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "timeReportingRequiresStartAndStopTimes": { "format": "int32", "type": "integer" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ContractServiceAdjustmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "adjustedUnitCost": { "format": "double", "type": "number" }, "adjustedUnitPrice": { "format": "double", "type": "number" }, "allowRepeatService": { "type": "boolean" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "effectiveDate": { "format": "date-time", "type": "string" }, "quoteItemID": { "format": "int32", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "unitChange": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractServiceAdjustment,Int64]]", "readOnly": true } } }, "Expression[Func[ContractServiceAdjustment,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ContractServiceBundleAdjustmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "adjustedUnitPrice": { "format": "double", "type": "number" }, "allowRepeatServiceBundle": { "type": "boolean" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "effectiveDate": { "format": "date-time", "type": "string" }, "quoteItemID": { "format": "int32", "type": "integer" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "unitChange": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractServiceBundleAdjustment,Int64]]", "readOnly": true } } }, "Expression[Func[ContractServiceBundleAdjustment,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractServiceBundleModel,ContractServiceBundle]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractServiceBundleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractServiceBundleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "adjustedPrice": { "format": "double", "type": "number" }, "contractID": { "format": "int32", "type": "integer" }, "internalCurrencyAdjustedPrice": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalDescription": { "type": "string" }, "invoiceDescription": { "type": "string" }, "quoteItemID": { "format": "int64", "type": "integer" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractServiceBundle,Int64]]", "readOnly": true } } }, "Expression[Func[ContractServiceBundle,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractServiceBundleUnitModel,ContractServiceBundleUnit]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractServiceBundleUnitModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ContractServiceModel,ContractService]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractServiceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractServiceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "internalCurrencyAdjustedPrice": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalDescription": { "type": "string" }, "invoiceDescription": { "type": "string" }, "quoteItemID": { "format": "int64", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractService,Int64]]", "readOnly": true } } }, "Expression[Func[ContractService,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ContractServiceUnitModel,ContractServiceUnit]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractServiceUnitModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ContractTicketPurchaseModel,ContractTicketPurchase]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ContractTicketPurchaseModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ContractTicketPurchaseModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "endDate": { "format": "date-time", "type": "string" }, "invoiceNumber": { "type": "string" }, "isPaid": { "type": "boolean" }, "paymentNumber": { "type": "string" }, "paymentType": { "format": "int32", "type": "integer" }, "perTicketRate": { "format": "double", "type": "number" }, "startDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "ticketsPurchased": { "format": "double", "type": "number" }, "ticketsUsed": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractTicketPurchase,Int64]]", "readOnly": true } } }, "Expression[Func[ContractTicketPurchase,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[CountryModel,Country]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CountryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CountryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "addressFormatID": { "format": "int64", "type": "integer" }, "countryCode": { "type": "string" }, "displayName": { "type": "string" }, "invoiceTemplateID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefaultCountry": { "type": "boolean" }, "name": { "type": "string" }, "purchaseOrderTemplateID": { "format": "int32", "type": "integer" }, "quoteTemplateID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[CurrencyModel,Currency]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/CurrencyModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "CurrencyModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyNegativeFormat": { "type": "string" }, "currencyPositiveFormat": { "type": "string" }, "description": { "type": "string" }, "displaySymbol": { "format": "int32", "type": "integer" }, "exchangeRate": { "format": "double", "type": "number" }, "isActive": { "type": "boolean" }, "isInternalCurrency": { "type": "boolean" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "updateResourceId": { "format": "int32", "type": "integer" } } }, "InvoiceTaxModel": { "type": "object", "properties": { "invoiceId": { "format": "int32", "type": "integer" }, "invoiceTaxTotal": { "format": "double", "type": "number" }, "invoiceNumber": { "type": "string" }, "webServiceDate": { "format": "date-time", "type": "string" }, "invoiceItemTaxes": { "type": "array", "items": { "$ref": "#/definitions/InvoiceItemTax" } } } }, "InvoiceItemTax": { "type": "object", "properties": { "billingItemPostedId": { "format": "int32", "type": "integer" }, "taxRegionName": { "type": "string" }, "taxCategoryName": { "type": "string" }, "effectiveTaxRate": { "format": "double", "type": "number" }, "totalTaxAmount": { "format": "double", "type": "number" }, "invoiceItemTaxDetails": { "type": "array", "items": { "$ref": "#/definitions/InvoiceItemTaxDetail" } } } }, "InvoiceItemTaxDetail": { "type": "object", "properties": { "taxName": { "type": "string" }, "taxRate": { "format": "double", "type": "number" }, "taxAmount": { "format": "double", "type": "number" } } }, "ProcessDattoAlertModel": { "type": "object", "properties": { "ticketEntity": { "$ref": "#/definitions/TicketModel" }, "endDeviceScreenshotAttachment": { "$ref": "#/definitions/TicketAttachmentModel" }, "deviceSnapshotNoteText": { "type": "string" }, "endDeviceSnapshotNoteText": { "type": "string" } } }, "TicketAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "ticketNoteID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "ProcessPaymentRequestModel": { "type": "object", "properties": { "accountId": { "format": "int32", "type": "integer" }, "contactId": { "format": "int32", "type": "integer" }, "originalTransactionIdentifier": { "type": "string" }, "invoicePayments": { "type": "array", "items": { "$ref": "#/definitions/InvoicePaymentModel" } } } }, "InvoicePaymentModel": { "type": "object", "properties": { "invoiceId": { "format": "int32", "type": "integer" }, "paymentAmount": { "format": "double", "type": "number" } } }, "UpdateInvoicePaymentUrlsModel": { "type": "object", "properties": { "invoicePaymentUrls": { "type": "array", "items": { "$ref": "#/definitions/InvoicePaymentUrlModel" } } } }, "InvoicePaymentUrlModel": { "type": "object", "properties": { "invoiceId": { "format": "int32", "type": "integer" }, "paymentUrl": { "type": "string" } } }, "QueryActionResult[DeletedTaskActivityLogModel,DeletedTaskActivityLog]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DeletedTaskActivityLogModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[DeletedTicketActivityLogModel,DeletedTicketActivityLog]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DeletedTicketActivityLogModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[DeletedTicketLogModel,DeletedTicketLog]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DeletedTicketLogModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[DepartmentModel,Department]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DepartmentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DepartmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "primaryLocationID": { "format": "int32", "type": "integer" } } }, "DocumentAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "publish": { "format": "int32", "type": "integer" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentCategoryModel,DocumentCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "parentCategoryID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[DocumentChecklistItemModel,DocumentChecklistItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentChecklistItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentChecklistItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "isImportant": { "type": "boolean" }, "itemName": { "type": "string" }, "position": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentChecklistItem,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentChecklistItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "DocumentChecklistLibraryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "checklistLibraryID": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentChecklistLibrary,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentChecklistLibrary,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentConfigurationItemAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentConfigurationItemAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentInstalledProductAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentInstalledProductAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentConfigurationItemCategoryAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentConfigurationItemCategoryAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "installedProductCategoryID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentInstalledProductCategoryAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentInstalledProductCategoryAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentNoteModel,DocumentNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createdDateTime": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "documentID": { "format": "int32", "type": "integer" }, "lastModifiedByResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentNote,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentPlainTextContentModel,DocumentPlainTextContent]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentPlainTextContentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentPlainTextContentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contentData": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentPlainTextContent,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentPlainTextContent,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentModel,Document]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createdDateTime": { "format": "date-time", "type": "string" }, "documentCategoryID": { "format": "int32", "type": "integer" }, "errorCodes": { "type": "string" }, "isActive": { "type": "boolean" }, "keywords": { "type": "string" }, "lastModifiedByResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "publish": { "format": "int32", "type": "integer" }, "referenceLink": { "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[Document,Int64]]", "readOnly": true } } }, "Expression[Func[Document,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentTagAssociationModel,DocumentTagAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentTagAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentTagAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "tagID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentTagAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentTagAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentTicketAssociationModel,DocumentTicketAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentTicketAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentTicketAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentTicketAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentTicketAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentToArticleAssociationModel,DocumentToArticleAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentToArticleAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentToArticleAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "associatedArticleID": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentToArticleAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentToArticleAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DocumentToDocumentAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DocumentToDocumentAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "associatedDocumentID": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[DocumentToDocumentAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[DocumentToDocumentAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[DomainRegistrarModel,DomainRegistrar]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DomainRegistrarModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "DomainRegistrarModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" } } }, "ExpenseItemAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "expenseItemID": { "format": "int32", "type": "integer" }, "expenseReportID": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ExpenseItemModel,ExpenseItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ExpenseItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ExpenseItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "destination": { "type": "string" }, "entertainmentLocation": { "type": "string" }, "expenseCategory": { "format": "int32", "type": "integer" }, "expenseCurrencyExpenseAmount": { "format": "double", "type": "number" }, "expenseCurrencyID": { "format": "int32", "type": "integer" }, "expenseDate": { "format": "date-time", "type": "string" }, "expenseReportID": { "format": "int32", "type": "integer" }, "glCode": { "type": "string" }, "haveReceipt": { "type": "boolean" }, "internalCurrencyExpenseAmount": { "format": "double", "type": "number" }, "internalCurrencyReimbursementAmount": { "format": "double", "type": "number" }, "isBillableToCompany": { "type": "boolean" }, "isReimbursable": { "type": "boolean" }, "isRejected": { "type": "boolean" }, "miles": { "format": "double", "type": "number" }, "odometerEnd": { "format": "double", "type": "number" }, "odometerStart": { "format": "double", "type": "number" }, "origin": { "type": "string" }, "paymentType": { "format": "int32", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "reimbursementCurrencyReimbursementAmount": { "format": "double", "type": "number" }, "taskID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "workType": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ExpenseItem,Int64]]", "readOnly": true } } }, "Expression[Func[ExpenseItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ExpenseReportAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "expenseItemID": { "format": "int32", "type": "integer" }, "expenseReportID": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ExpenseReportModel,ExpenseReport]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ExpenseReportModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ExpenseReportModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "amountDue": { "format": "double", "type": "number" }, "approvedDate": { "format": "date-time", "type": "string" }, "approverID": { "format": "int32", "type": "integer" }, "departmentNumber": { "type": "string" }, "internalCurrencyCashAdvanceAmount": { "format": "double", "type": "number" }, "internalCurrencyExpenseTotal": { "format": "double", "type": "number" }, "name": { "type": "string" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "quickBooksReferenceNumber": { "type": "string" }, "reimbursementCurrencyAmountDue": { "format": "double", "type": "number" }, "reimbursementCurrencyCashAdvanceAmount": { "format": "double", "type": "number" }, "reimbursementCurrencyID": { "format": "int32", "type": "integer" }, "rejectionReason": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "submit": { "type": "boolean" }, "submitDate": { "format": "date-time", "type": "string" }, "submitterID": { "format": "int32", "type": "integer" }, "weekEnding": { "format": "date-time", "type": "string" } } }, "QueryActionResult[HolidayModel,Holiday]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/HolidayModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "HolidayModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "holidayDate": { "format": "date-time", "type": "string" }, "holidayName": { "type": "string" }, "holidaySetID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[Holiday,Int64]]", "readOnly": true } } }, "Expression[Func[Holiday,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[HolidaySetModel,HolidaySet]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/HolidaySetModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "HolidaySetModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "holidaySetDescription": { "type": "string" }, "holidaySetName": { "type": "string" } } }, "QueryActionResult[IntegrationVendorInsightModel,IntegrationVendorInsight]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/IntegrationVendorInsightModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "IntegrationVendorInsightModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "height": { "format": "int32", "type": "integer" }, "insightCategory": { "format": "int32", "type": "integer" }, "insightKey": { "type": "string" }, "isActive": { "type": "boolean" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "referenceUrl": { "type": "string" }, "secret": { "type": "string" }, "title": { "type": "string" }, "vendorSuppliedID": { "type": "string" } } }, "QueryActionResult[IntegrationVendorWidgetModel,IntegrationVendorWidget]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/IntegrationVendorWidgetModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "IntegrationVendorWidgetModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "referenceUrl": { "type": "string" }, "secret": { "type": "string" }, "title": { "type": "string" }, "vendorSuppliedID": { "type": "string" }, "widgetKey": { "type": "string" }, "width": { "format": "int32", "type": "integer" } } }, "QueryActionResult[InternalLocationModel,InternalLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InternalLocationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[InternalLocationWithBusinessHoursModel,BusinessLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InternalLocationWithBusinessHoursModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InternalLocationWithBusinessHoursModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalAddressInfo": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "countryID": { "format": "int32", "type": "integer" }, "dateFormat": { "type": "string" }, "firstDayOfWeek": { "format": "int32", "type": "integer" }, "fridayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "fridayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "fridayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "fridayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "holidayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "holidayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "holidayHoursEndTime": { "format": "date-time", "type": "string" }, "holidayHoursStartTime": { "format": "date-time", "type": "string" }, "holidayHoursType": { "format": "int32", "type": "integer" }, "holidaySetID": { "format": "int32", "type": "integer" }, "isDefault": { "type": "boolean" }, "mondayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "mondayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "mondayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "mondayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "noHoursOnHolidays": { "type": "boolean" }, "numberFormat": { "type": "string" }, "postalCode": { "type": "string" }, "saturdayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "saturdayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "saturdayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "saturdayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "state": { "type": "string" }, "sundayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "sundayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "sundayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "sundayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "thursdayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "thursdayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "thursdayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "thursdayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "timeFormat": { "type": "string" }, "timeZoneID": { "format": "int32", "type": "integer" }, "tuesdayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "tuesdayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "tuesdayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "tuesdayExtendedHoursStartTime": { "format": "date-time", "type": "string" }, "wednesdayBusinessHoursEndTime": { "format": "date-time", "type": "string" }, "wednesdayBusinessHoursStartTime": { "format": "date-time", "type": "string" }, "wednesdayExtendedHoursEndTime": { "format": "date-time", "type": "string" }, "wednesdayExtendedHoursStartTime": { "format": "date-time", "type": "string" } } }, "QueryActionResult[InventoryItemModel,InventoryItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "backOrderQuantity": { "format": "int32", "type": "integer" }, "bin": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "inventoryLocationID": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "quantityMaximum": { "format": "int32", "type": "integer" }, "quantityMinimum": { "format": "int32", "type": "integer" }, "quantityOnHand": { "format": "int32", "type": "integer" }, "quantityOnOrder": { "format": "int32", "type": "integer" }, "quantityPicked": { "format": "int32", "type": "integer" }, "quantityReserved": { "format": "int32", "type": "integer" }, "referenceNumber": { "type": "string" } } }, "QueryActionResult[InventoryItemSerialNumberModel,InventoryItemSerialNumber]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryItemSerialNumberModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryItemSerialNumberModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "inventoryItemID": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryItemSerialNumber,Int64]]", "readOnly": true } } }, "Expression[Func[InventoryItemSerialNumber,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[InventoryLocationModel,InventoryLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryLocationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryLocationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "locationName": { "type": "string" }, "resourceID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[InventoryProductModel,InventoryProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryProductModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryProductModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "availableUnits": { "format": "int32", "type": "integer" }, "backOrderQuantity": { "format": "int32", "type": "integer" }, "bin": { "type": "string" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "inventoryLocationID": { "format": "int32", "type": "integer" }, "onHandUnits": { "format": "int32", "type": "integer" }, "pickedUnits": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "quantityMaximum": { "format": "int32", "type": "integer" }, "quantityMinimum": { "format": "int32", "type": "integer" }, "referenceNumber": { "type": "string" }, "reservedUnits": { "format": "int32", "type": "integer" }, "unitsOnOrder": { "format": "int32", "type": "integer" } } }, "QueryActionResult[InventoryStockedItemModel,InventoryStockedItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryStockedItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryStockedItemAddModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "determineNewPriceUsing": { "format": "int32", "type": "integer" }, "determineCostUsing": { "format": "int32", "type": "integer" }, "inventoryProductID": { "format": "int32", "type": "integer" }, "pricePercentage": { "format": "double", "type": "number" }, "quantityBeingAdded": { "format": "int32", "type": "integer" }, "reasonForUpdate": { "type": "string" }, "returnPrice": { "format": "double", "type": "number" }, "returnTypeID": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "unitCost": { "format": "double", "type": "number" }, "vendorID": { "format": "int32", "type": "integer" }, "vendorInvoiceNumber": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryStockedItemAdd,Int64]]", "readOnly": true } } }, "Expression[Func[InventoryStockedItemAdd,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "InventoryStockedItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "availableUnits": { "format": "int32", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "currentInventoryLocationID": { "format": "int32", "type": "integer" }, "deliveredUnits": { "format": "int32", "type": "integer" }, "inventoryProductID": { "format": "int32", "type": "integer" }, "purchaseOrderItemReceivingID": { "format": "int32", "type": "integer" }, "onHandUnits": { "format": "int32", "type": "integer" }, "parentInventoryStockedItemID": { "format": "int32", "type": "integer" }, "pickedRemovedByResourceID": { "format": "int32", "type": "integer" }, "pickedRemovedDateTime": { "format": "date-time", "type": "string" }, "pickedUnits": { "format": "int32", "type": "integer" }, "purchaseOrderID": { "format": "int32", "type": "integer" }, "purchaseOrderItemID": { "format": "int32", "type": "integer" }, "quoteItemID": { "format": "int32", "type": "integer" }, "removedUnits": { "format": "int32", "type": "integer" }, "reservedUnits": { "format": "int32", "type": "integer" }, "returnPrice": { "format": "double", "type": "number" }, "returnTypeID": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "statusID": { "format": "int32", "type": "integer" }, "transferredUnits": { "format": "int32", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "vendorID": { "format": "int32", "type": "integer" }, "vendorInvoiceNumber": { "type": "string" }, "parentStockedItemReceivedUnits": { "format": "int32", "type": "integer" }, "contractChargeID": { "format": "int32", "type": "integer" }, "projectChargeID": { "format": "int32", "type": "integer" }, "ticketChargeID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryStockedItem,Int64]]", "readOnly": true } } }, "Expression[Func[InventoryStockedItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "InventoryStockedItemRemoveModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "inventoryProductID": { "format": "int32", "type": "integer" }, "inventoryStockedItemID": { "format": "int32", "type": "integer" }, "quantityBeingRemoved": { "format": "int32", "type": "integer" }, "reasonForUpdate": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryStockedItemRemove,Int64]]", "readOnly": true } } }, "Expression[Func[InventoryStockedItemRemove,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "InventoryStockedItemTransferModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "newInventoryLocationID": { "format": "int32", "type": "integer" }, "inventoryProductID": { "format": "int32", "type": "integer" }, "inventoryStockedItemID": { "format": "int32", "type": "integer" }, "quantityBeingTransferred": { "format": "int32", "type": "integer" }, "reasonForUpdate": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryStockedItemTransfer,Int64]]", "readOnly": true } } }, "Expression[Func[InventoryStockedItemTransfer,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[InventoryTransferModel,InventoryTransfer]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InventoryTransferModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InventoryTransferModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fromLocationID": { "format": "int64", "type": "integer" }, "notes": { "type": "string" }, "productID": { "format": "int64", "type": "integer" }, "quantityTransferred": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "toLocationID": { "format": "int64", "type": "integer" }, "transferByResourceID": { "format": "int32", "type": "integer" }, "transferDate": { "format": "date-time", "type": "string" }, "updateNote": { "type": "string" } } }, "QueryActionResult[InvoiceModel,Invoice]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InvoiceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "InvoiceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "batchID": { "format": "int32", "type": "integer" }, "comments": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "dueDate": { "format": "date-time", "type": "string" }, "fromDate": { "format": "date-time", "type": "string" }, "invoiceDateTime": { "format": "date-time", "type": "string" }, "invoiceEditorTemplateID": { "format": "int32", "type": "integer" }, "invoiceNumber": { "type": "string" }, "invoiceTotal": { "format": "double", "type": "number" }, "isVoided": { "type": "boolean" }, "orderNumber": { "type": "string" }, "paidDate": { "format": "date-time", "type": "string" }, "paymentTerm": { "format": "int32", "type": "integer" }, "taxGroup": { "format": "int32", "type": "integer" }, "taxRegionName": { "type": "string" }, "toDate": { "format": "date-time", "type": "string" }, "totalTaxValue": { "format": "double", "type": "number" }, "voidedByResourceID": { "format": "int32", "type": "integer" }, "voidedDate": { "format": "date-time", "type": "string" }, "webServiceDate": { "format": "date-time", "type": "string" }, "invoiceStatus": { "format": "int32", "type": "integer" }, "invoiceTaxMethodExternalCode": { "type": "string" } } }, "QueryActionResult[InvoiceTemplateModel,InvoiceTemplate]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/InvoiceTemplateModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[KnowledgeBaseArticleModel,KnowledgeBaseArticle]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/KnowledgeBaseArticleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "KnowledgeBaseArticleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createdDateTime": { "format": "date-time", "type": "string" }, "articleCategoryID": { "format": "int32", "type": "integer" }, "errorCodes": { "type": "string" }, "isActive": { "type": "boolean" }, "keywords": { "type": "string" }, "lastModifiedByResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "publish": { "format": "int32", "type": "integer" }, "referenceLink": { "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[KnowledgeBaseArticle,Int64]]", "readOnly": true } } }, "Expression[Func[KnowledgeBaseArticle,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[KnowledgeBaseCategoryModel,KnowledgeBaseCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/KnowledgeBaseCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "KnowledgeBaseCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "parentCategoryID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[NotificationHistoryModel,NotificationHistory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/NotificationHistoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[OpportunityModel,Opportunity]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OpportunityModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "OpportunityModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "advancedField1": { "format": "double", "type": "number" }, "advancedField2": { "format": "double", "type": "number" }, "advancedField3": { "format": "double", "type": "number" }, "advancedField4": { "format": "double", "type": "number" }, "advancedField5": { "format": "double", "type": "number" }, "amount": { "format": "double", "type": "number" }, "assessmentScore": { "format": "double", "type": "number" }, "barriers": { "type": "string" }, "closedDate": { "format": "date-time", "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "helpNeeded": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "lastActivity": { "format": "date-time", "type": "string" }, "leadSource": { "format": "int32", "type": "integer" }, "lossReason": { "format": "int32", "type": "integer" }, "lossReasonDetail": { "type": "string" }, "lostDate": { "format": "date-time", "type": "string" }, "market": { "type": "string" }, "monthlyCost": { "format": "double", "type": "number" }, "monthlyRevenue": { "format": "double", "type": "number" }, "nextStep": { "type": "string" }, "onetimeCost": { "format": "double", "type": "number" }, "onetimeRevenue": { "format": "double", "type": "number" }, "opportunityCategoryID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "primaryCompetitor": { "format": "int32", "type": "integer" }, "probability": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "projectedCloseDate": { "format": "date-time", "type": "string" }, "promisedFulfillmentDate": { "format": "date-time", "type": "string" }, "promotionName": { "type": "string" }, "quarterlyCost": { "format": "double", "type": "number" }, "quarterlyRevenue": { "format": "double", "type": "number" }, "rating": { "format": "int32", "type": "integer" }, "relationshipAssessmentScore": { "format": "double", "type": "number" }, "revenueSpread": { "format": "int32", "type": "integer" }, "revenueSpreadUnit": { "type": "string" }, "salesOrderID": { "format": "int32", "type": "integer" }, "salesProcessPercentComplete": { "format": "double", "type": "number" }, "semiannualCost": { "format": "double", "type": "number" }, "semiannualRevenue": { "format": "double", "type": "number" }, "stage": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "technicalAssessmentScore": { "format": "double", "type": "number" }, "throughDate": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "totalAmountMonths": { "format": "int32", "type": "integer" }, "useQuoteTotals": { "type": "boolean" }, "winReason": { "format": "int32", "type": "integer" }, "winReasonDetail": { "type": "string" }, "yearlyCost": { "format": "double", "type": "number" }, "yearlyRevenue": { "format": "double", "type": "number" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "OpportunityAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[OpportunityCategoryModel,OpportunityCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OpportunityCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "OpportunityCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "displayColorRGB": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isGlobalDefault": { "type": "boolean" }, "name": { "type": "string" }, "nickname": { "type": "string" } } }, "QueryActionResult[OrganizationalLevel1Model,BusinessDivision]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OrganizationalLevel1Model" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "OrganizationalLevel1Model": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[OrganizationalLevel2Model,BusinessSubdivision]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OrganizationalLevel2Model" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "OrganizationalLevel2Model": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[OrganizationalLevelAssociationModel,BusinessDivisionSubdivision]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OrganizationalLevelAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "OrganizationalLevelAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "organizationalLevel1ID": { "format": "int32", "type": "integer" }, "organizationalLevel2ID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/OrganizationalResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[PaymentTermModel,PaymentTerm]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PaymentTermModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PaymentTermModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "paymentDueInDays": { "format": "int32", "type": "integer" } } }, "QueryActionResult[PhaseModel,Phase]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PhaseModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PhaseModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "dueDate": { "format": "date-time", "type": "string" }, "estimatedHours": { "format": "double", "type": "number" }, "externalID": { "type": "string" }, "isScheduled": { "type": "boolean" }, "lastActivityDateTime": { "format": "date-time", "type": "string" }, "parentPhaseID": { "format": "int32", "type": "integer" }, "phaseNumber": { "type": "string" }, "projectID": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[Phase,Int64]]", "readOnly": true } } }, "Expression[Func[Phase,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[PriceListMaterialCodeModel,PriceListMaterialCode]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListMaterialCodeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListMaterialCodeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" } } }, "QueryActionResult[PriceListProductModel,PriceListProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListProductModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListProductModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" } } }, "QueryActionResult[PriceListProductTierModel,PriceListProductTier]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListProductTierModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListProductTierModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "productTierID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[PriceListProductTier,Int64]]", "readOnly": true } } }, "Expression[Func[PriceListProductTier,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[PriceListRoleModel,PriceListRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListRoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListRoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "hourlyRate": { "format": "double", "type": "number" }, "roleID": { "format": "int32", "type": "integer" }, "usesInternalCurrencyPrice": { "type": "boolean" } } }, "QueryActionResult[PriceListServiceBundleModel,PriceListServiceBundle]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListServiceBundleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListServiceBundleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" } } }, "QueryActionResult[PriceListServiceModel,PriceListService]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListServiceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListServiceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "unitPrice": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" } } }, "QueryActionResult[PriceListWorkTypeModifierModel,PriceListWorkTypeModifier]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PriceListWorkTypeModifierModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PriceListWorkTypeModifierModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "currencyID": { "format": "int32", "type": "integer" }, "modifierType": { "format": "int32", "type": "integer" }, "modifierValue": { "format": "double", "type": "number" }, "usesInternalCurrencyPrice": { "type": "boolean" }, "workTypeModifierID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[ProductNoteModel,ProductNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProductNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProductNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "productID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ProductNote,Int64]]", "readOnly": true } } }, "Expression[Func[ProductNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ProductModel,Product]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProductModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProductModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingType": { "format": "int32", "type": "integer" }, "chargeBillingCodeID": { "format": "int32", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createdTime": { "format": "date-time", "type": "string" }, "defaultVendorID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "doesNotRequireProcurement": { "type": "boolean" }, "externalProductID": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "internalProductID": { "type": "string" }, "isActive": { "type": "boolean" }, "isEligibleForRma": { "type": "boolean" }, "isSerialized": { "type": "boolean" }, "link": { "type": "string" }, "manufacturerName": { "type": "string" }, "manufacturerProductName": { "type": "string" }, "markupRate": { "format": "double", "type": "number" }, "msrp": { "format": "double", "type": "number" }, "name": { "type": "string" }, "periodType": { "format": "int32", "type": "integer" }, "priceCostMethod": { "format": "int32", "type": "integer" }, "productBillingCodeID": { "format": "int32", "type": "integer" }, "productCategory": { "format": "int32", "type": "integer" }, "sku": { "type": "string" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "vendorProductNumber": { "type": "string" }, "defaultInstalledProductCategoryID": { "format": "int32", "type": "integer" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[ProductTierModel,ProductTier]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProductTierModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProductTierModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "upToUnitCount": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ProductTier,Int64]]", "readOnly": true } } }, "Expression[Func[ProductTier,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ProductVendorModel,ProductVendor]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProductVendorModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProductVendorModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "productID": { "format": "int32", "type": "integer" }, "vendorCost": { "format": "double", "type": "number" }, "vendorID": { "format": "int32", "type": "integer" }, "vendorPartNumber": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ProductVendor,Int64]]", "readOnly": true } } }, "Expression[Func[ProductVendor,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ProjectAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "projectNoteID": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ProjectChargeModel,ProjectCost]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProjectChargeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProjectChargeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billableAmount": { "format": "double", "type": "number" }, "billingCodeID": { "format": "int64", "type": "integer" }, "chargeType": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int64", "type": "integer" }, "contractServiceID": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int64", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "estimatedCost": { "format": "double", "type": "number" }, "extendedCost": { "format": "double", "type": "number" }, "internalCurrencyBillableAmount": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalPurchaseOrderNumber": { "type": "string" }, "isBillableToCompany": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "productID": { "format": "int64", "type": "integer" }, "projectID": { "format": "int64", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "status": { "format": "int64", "type": "integer" }, "statusLastModifiedBy": { "format": "int64", "type": "integer" }, "statusLastModifiedDate": { "format": "date-time", "type": "string" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "unitQuantity": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ProjectCost,Int64]]", "readOnly": true } } }, "Expression[Func[ProjectCost,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "ProjectNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "projectNoteID": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ProjectNoteModel,ProjectNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProjectNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProjectNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByContactID": { "format": "int32", "type": "integer" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "isAnnouncement": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "noteType": { "format": "int32", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ProjectNote,Int64]]", "readOnly": true } } }, "Expression[Func[ProjectNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ProjectModel,Project]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ProjectModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ProjectModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "actualBilledHours": { "format": "double", "type": "number" }, "actualHours": { "format": "double", "type": "number" }, "changeOrdersBudget": { "format": "double", "type": "number" }, "changeOrdersRevenue": { "format": "double", "type": "number" }, "companyID": { "format": "int32", "type": "integer" }, "companyOwnerResourceID": { "format": "int32", "type": "integer" }, "completedDateTime": { "format": "date-time", "type": "string" }, "completedPercentage": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "department": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "duration": { "format": "int32", "type": "integer" }, "endDateTime": { "format": "date-time", "type": "string" }, "estimatedSalesCost": { "format": "double", "type": "number" }, "estimatedTime": { "format": "double", "type": "number" }, "extProjectNumber": { "type": "string" }, "extProjectType": { "format": "int32", "type": "integer" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "laborEstimatedCosts": { "format": "double", "type": "number" }, "laborEstimatedMarginPercentage": { "format": "double", "type": "number" }, "laborEstimatedRevenue": { "format": "double", "type": "number" }, "lastActivityDateTime": { "format": "date-time", "type": "string" }, "lastActivityPersonType": { "format": "int32", "type": "integer" }, "lastActivityResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "originalEstimatedRevenue": { "format": "double", "type": "number" }, "projectCostEstimatedMarginPercentage": { "format": "double", "type": "number" }, "projectCostsBudget": { "format": "double", "type": "number" }, "projectCostsRevenue": { "format": "double", "type": "number" }, "projectLeadResourceID": { "format": "int32", "type": "integer" }, "projectName": { "type": "string" }, "projectNumber": { "type": "string" }, "projectType": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "sgda": { "format": "double", "type": "number" }, "startDateTime": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "statusDateTime": { "format": "date-time", "type": "string" }, "statusDetail": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[PurchaseApprovalModel,PurchaseApproval]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PurchaseApprovalModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PurchaseApprovalModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "costType": { "type": "string" }, "isApproved": { "type": "boolean" }, "rejectNote": { "type": "string" } } }, "QueryActionResult[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PurchaseOrderItemReceivingModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PurchaseOrderItemReceivingModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "purchaseOrderItemID": { "format": "int64", "type": "integer" }, "quantityBackOrdered": { "format": "int32", "type": "integer" }, "quantityNowReceiving": { "format": "int32", "type": "integer" }, "quantityPreviouslyReceived": { "format": "int32", "type": "integer" }, "receiveDate": { "format": "date-time", "type": "string" }, "receivedByResourceID": { "format": "int32", "type": "integer" }, "serialNumber": { "type": "string" }, "vendorInvoiceNumber": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[PurchaseOrderReceive,Int64]]", "readOnly": true } } }, "Expression[Func[PurchaseOrderReceive,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[PurchaseOrderItemModel,PurchaseOrderItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PurchaseOrderItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PurchaseOrderItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "chargeID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int64", "type": "integer" }, "estimatedArrivalDate": { "format": "date-time", "type": "string" }, "internalCurrencyUnitCost": { "format": "double", "type": "number" }, "inventoryLocationID": { "format": "int32", "type": "integer" }, "memo": { "type": "string" }, "orderID": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "projectID": { "format": "int64", "type": "integer" }, "quantity": { "format": "int32", "type": "integer" }, "salesOrderID": { "format": "int64", "type": "integer" }, "ticketID": { "format": "int64", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[PurchaseOrderItem,Int64]]", "readOnly": true } } }, "Expression[Func[PurchaseOrderItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[PurchaseOrderModel,PurchaseOrder]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/PurchaseOrderModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "PurchaseOrderModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "cancelDateTime": { "format": "date-time", "type": "string" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "externalPONumber": { "type": "string" }, "fax": { "type": "string" }, "freight": { "format": "double", "type": "number" }, "generalMemo": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "internalCurrencyFreight": { "format": "double", "type": "number" }, "latestEstimatedArrivalDate": { "format": "date-time", "type": "string" }, "paymentTerm": { "format": "int32", "type": "integer" }, "phone": { "type": "string" }, "purchaseForCompanyID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "purchaseOrderTemplateID": { "format": "int32", "type": "integer" }, "shippingDate": { "format": "date-time", "type": "string" }, "shippingType": { "format": "int32", "type": "integer" }, "shipToAddress1": { "type": "string" }, "shipToAddress2": { "type": "string" }, "shipToCity": { "type": "string" }, "shipToName": { "type": "string" }, "shipToPostalCode": { "type": "string" }, "shipToState": { "type": "string" }, "showEachTaxInGroup": { "type": "boolean" }, "showTaxCategory": { "type": "boolean" }, "status": { "format": "int32", "type": "integer" }, "submitDateTime": { "format": "date-time", "type": "string" }, "taxRegionID": { "format": "int32", "type": "integer" }, "useItemDescriptionsFrom": { "format": "int32", "type": "integer" }, "vendorID": { "format": "int32", "type": "integer" }, "vendorInvoiceNumber": { "type": "string" }, "additionalVendorInvoiceNumbers": { "type": "string" } } }, "QueryActionResult[QuoteItemModel,QuoteItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/QuoteItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QuoteItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "averageCost": { "format": "double", "type": "number" }, "chargeID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "expenseID": { "format": "int32", "type": "integer" }, "highestCost": { "format": "double", "type": "number" }, "internalCurrencyLineDiscount": { "format": "double", "type": "number" }, "internalCurrencyUnitDiscount": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "isOptional": { "type": "boolean" }, "isTaxable": { "type": "boolean" }, "laborID": { "format": "int32", "type": "integer" }, "lineDiscount": { "format": "double", "type": "number" }, "markupRate": { "format": "double", "type": "number" }, "name": { "type": "string" }, "percentageDiscount": { "format": "double", "type": "number" }, "periodType": { "format": "int32", "type": "integer" }, "productID": { "format": "int32", "type": "integer" }, "quantity": { "format": "double", "type": "number" }, "quoteID": { "format": "int32", "type": "integer" }, "quoteItemType": { "format": "int32", "type": "integer" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "serviceID": { "format": "int32", "type": "integer" }, "shippingID": { "format": "int32", "type": "integer" }, "sortOrderID": { "format": "int32", "type": "integer" }, "taxCategoryID": { "format": "int32", "type": "integer" }, "totalEffectiveTax": { "format": "double", "type": "number" }, "unitCost": { "format": "double", "type": "number" }, "unitDiscount": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[QuoteItem,Int64]]", "readOnly": true } } }, "Expression[Func[QuoteItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[QuoteLocationModel,QuoteLocation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/QuoteLocationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QuoteLocationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "QueryActionResult[QuoteModel,Quote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/QuoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QuoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approvalStatus": { "format": "int32", "type": "integer" }, "approvalStatusChangedByResourceID": { "format": "int32", "type": "integer" }, "approvalStatusChangedDate": { "format": "date-time", "type": "string" }, "billToLocationID": { "format": "int32", "type": "integer" }, "calculateTaxSeparately": { "type": "boolean" }, "comment": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "effectiveDate": { "format": "date-time", "type": "string" }, "expirationDate": { "format": "date-time", "type": "string" }, "extApprovalContactResponse": { "format": "int32", "type": "integer" }, "extApprovalResponseDate": { "format": "date-time", "type": "string" }, "extApprovalResponseSignature": { "type": "string" }, "externalQuoteNumber": { "type": "string" }, "groupByID": { "format": "int32", "type": "integer" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastModifiedBy": { "format": "int32", "type": "integer" }, "lastPublishedByResourceID": { "format": "int32", "type": "integer" }, "lastPublishedDateTime": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "opportunityID": { "format": "int32", "type": "integer" }, "paymentTerm": { "format": "int32", "type": "integer" }, "paymentType": { "format": "int32", "type": "integer" }, "primaryQuote": { "type": "boolean" }, "proposalProjectID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "quoteNumber": { "format": "int32", "type": "integer" }, "quoteTemplateID": { "format": "int32", "type": "integer" }, "shippingType": { "format": "int32", "type": "integer" }, "shipToLocationID": { "format": "int32", "type": "integer" }, "showEachTaxInGroup": { "type": "boolean" }, "showTaxCategory": { "type": "boolean" }, "soldToLocationID": { "format": "int32", "type": "integer" }, "taxRegionID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[QuoteTemplateModel,QuoteTemplate]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/QuoteTemplateModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceDailyAvailabilityModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceDailyAvailabilityModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "sundayAvailableHours": { "format": "double", "type": "number" }, "mondayAvailableHours": { "format": "double", "type": "number" }, "tuesdayAvailableHours": { "format": "double", "type": "number" }, "wednesdayAvailableHours": { "format": "double", "type": "number" }, "thursdayAvailableHours": { "format": "double", "type": "number" }, "fridayAvailableHours": { "format": "double", "type": "number" }, "saturdayAvailableHours": { "format": "double", "type": "number" }, "weeklyBillableHoursGoal": { "format": "double", "type": "number" }, "travelAvailability": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceDailyAvailability,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceDailyAvailability,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceRoleDepartmentModel,ResourceRoleDepartment]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceRoleDepartmentModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceRoleDepartmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "departmentID": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isDepartmentLead": { "type": "boolean" }, "resourceID": { "format": "int32", "type": "integer" }, "roleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceRoleDepartment,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceRoleDepartment,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceRoleQueueModel,ResourceRoleQueue]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceRoleQueueModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceRoleQueueModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "queueID": { "format": "int32", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceRoleQueue,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceRoleQueue,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceRoleModel,ResourceRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceRoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ResourceModel,Resource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "accountingReferenceID": { "type": "string" }, "dateFormat": { "type": "string" }, "defaultServiceDeskRoleID": { "format": "int64", "type": "integer" }, "email": { "type": "string" }, "email2": { "type": "string" }, "email3": { "type": "string" }, "emailTypeCode": { "type": "string" }, "emailTypeCode2": { "type": "string" }, "emailTypeCode3": { "type": "string" }, "firstName": { "type": "string" }, "gender": { "type": "string" }, "greeting": { "format": "int32", "type": "integer" }, "hireDate": { "format": "date-time", "type": "string" }, "homePhone": { "type": "string" }, "initials": { "type": "string" }, "internalCost": { "format": "double", "type": "number" }, "isActive": { "type": "boolean" }, "lastName": { "type": "string" }, "licenseType": { "format": "int32", "type": "integer" }, "locationID": { "format": "int32", "type": "integer" }, "middleName": { "type": "string" }, "mobilePhone": { "type": "string" }, "numberFormat": { "type": "string" }, "officeExtension": { "type": "string" }, "officePhone": { "type": "string" }, "payrollIdentifier": { "type": "string" }, "payrollType": { "format": "int32", "type": "integer" }, "resourceType": { "type": "string" }, "suffix": { "format": "int32", "type": "integer" }, "surveyResourceRating": { "format": "double", "type": "number" }, "timeFormat": { "type": "string" }, "title": { "type": "string" }, "travelAvailabilityPct": { "type": "string" }, "userName": { "type": "string" }, "userType": { "format": "int32", "type": "integer" } } }, "QueryActionResult[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceServiceDeskRoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceServiceDeskRoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "resourceID": { "format": "int32", "type": "integer" }, "roleID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceServiceDeskRole,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceServiceDeskRole,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceSkillModel,ResourceSkill]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceSkillModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceSkillModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int64", "type": "integer" }, "skillDescription": { "type": "string" }, "skillID": { "format": "int64", "type": "integer" }, "skillLevel": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceSkill,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceSkill,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceTimeOffAdditionalModel,ResourceTimeOffAdditional]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceTimeOffAdditionalModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ResourceTimeOffAdditionalModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "currentYear": { "format": "int32", "type": "integer" }, "currentYearAdditionalVacationTime": { "format": "double", "type": "number" }, "currentYearAdditionalPersonalTime": { "format": "double", "type": "number" }, "currentYearAdditionalSickTime": { "format": "double", "type": "number" }, "currentYearAdditionalFloatingHoliday": { "format": "double", "type": "number" }, "currentYearAnnualVacationTime": { "format": "double", "type": "number" }, "currentYearAnnualPersonalTime": { "format": "double", "type": "number" }, "currentYearAnnualSickTime": { "format": "double", "type": "number" }, "currentYearAnnualFloatingHoliday": { "format": "double", "type": "number" }, "nextYear": { "format": "int32", "type": "integer" }, "nextYearAdditionalVacationTime": { "format": "double", "type": "number" }, "nextYearAdditionalPersonalTime": { "format": "double", "type": "number" }, "nextYearAdditionalSickTime": { "format": "double", "type": "number" }, "nextYearAdditionalFloatingHoliday": { "format": "double", "type": "number" }, "nextYearAnnualVacationTime": { "format": "double", "type": "number" }, "nextYearAnnualPersonalTime": { "format": "double", "type": "number" }, "nextYearAnnualSickTime": { "format": "double", "type": "number" }, "nextYearAnnualFloatingHoliday": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ResourceTimeOffAdditional,Int64]]", "readOnly": true } } }, "Expression[Func[ResourceTimeOffAdditional,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ResourceTimeOffApproverModel,ResourceTimeOffApprover]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceTimeOffApproverModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ResourceTimeOffBalanceModel,ResourceTimeOffBalance]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ResourceTimeOffBalanceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[RoleModel,Role]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/RoleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "RoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "hourlyFactor": { "format": "double", "type": "number" }, "hourlyRate": { "format": "double", "type": "number" }, "isActive": { "type": "boolean" }, "isExcludedFromNewContracts": { "type": "boolean" }, "isSystemRole": { "type": "boolean" }, "name": { "type": "string" }, "quoteItemDefaultTaxCategoryId": { "format": "int32", "type": "integer" }, "roleType": { "format": "int32", "type": "integer" } } }, "SalesOrderAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "salesOrderID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[SalesOrderModel,SalesOrder]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SalesOrderModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "SalesOrderModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalBillToAddressInformation": { "type": "string" }, "additionalShipToAddressInformation": { "type": "string" }, "billingAddress1": { "type": "string" }, "billingAddress2": { "type": "string" }, "billToCity": { "type": "string" }, "billToCountryID": { "format": "int32", "type": "integer" }, "billToPostalCode": { "type": "string" }, "billToState": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "promisedFulfillmentDate": { "format": "date-time", "type": "string" }, "salesOrderDate": { "format": "date-time", "type": "string" }, "shipToAddress1": { "type": "string" }, "shipToAddress2": { "type": "string" }, "shipToCity": { "type": "string" }, "shipToCountryID": { "format": "int32", "type": "integer" }, "shipToPostalCode": { "type": "string" }, "shipToState": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[SalesOrder,Int64]]", "readOnly": true }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[SalesOrder,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceBundleModel,ServiceBundle]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceBundleModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceBundleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "invoiceDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "lastModifiedDate": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "percentageDiscount": { "format": "double", "type": "number" }, "periodType": { "format": "int32", "type": "integer" }, "serviceLevelAgreementID": { "format": "int64", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitDiscount": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "updateResourceID": { "format": "int32", "type": "integer" }, "manufacturerServiceProvider": { "type": "string" }, "manufacturerServiceProviderProductNumber": { "type": "string" }, "catalogNumberPartNumber": { "type": "string" }, "sku": { "type": "string" }, "internalID": { "type": "string" }, "externalID": { "type": "string" }, "url": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[ServiceBundleServiceModel,ServiceBundleService]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceBundleServiceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceBundleServiceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "serviceBundleID": { "format": "int64", "type": "integer" }, "serviceID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ServiceBundleService,Int64]]", "readOnly": true } } }, "Expression[Func[ServiceBundleService,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceCallModel,ServiceCall]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceCallModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceCallModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "cancelationNoticeHours": { "format": "double", "type": "number" }, "canceledByResourceID": { "format": "int32", "type": "integer" }, "canceledDateTime": { "format": "date-time", "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyLocationID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "duration": { "format": "double", "type": "number" }, "endDateTime": { "format": "date-time", "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "isComplete": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "startDateTime": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" } } }, "QueryActionResult[ServiceCallTaskResourceModel,ServiceCallTaskResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceCallTaskResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceCallTaskResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "serviceCallTaskID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ServiceCallTaskResource,Int64]]", "readOnly": true } } }, "Expression[Func[ServiceCallTaskResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceCallTaskModel,ServiceCallTask]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceCallTaskModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceCallTaskModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "serviceCallID": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ServiceCallTask,Int64]]", "readOnly": true } } }, "Expression[Func[ServiceCallTask,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceCallTicketResourceModel,ServiceCallTicketResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceCallTicketResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceCallTicketResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "serviceCallTicketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ServiceCallTicketResource,Int64]]", "readOnly": true } } }, "Expression[Func[ServiceCallTicketResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceCallTicketModel,ServiceCallTicket]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceCallTicketModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceCallTicketModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "serviceCallID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ServiceCallTicket,Int64]]", "readOnly": true } } }, "Expression[Func[ServiceCallTicket,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceLevelAgreementResultsModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[ServiceModel,Service]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ServiceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "ServiceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "invoiceDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "lastModifiedDate": { "format": "date-time", "type": "string" }, "markupRate": { "format": "double", "type": "number" }, "name": { "type": "string" }, "periodType": { "format": "int32", "type": "integer" }, "serviceLevelAgreementID": { "format": "int64", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "updateResourceID": { "format": "int32", "type": "integer" }, "vendorCompanyID": { "format": "int32", "type": "integer" }, "manufacturerServiceProvider": { "type": "string" }, "manufacturerServiceProviderProductNumber": { "type": "string" }, "catalogNumberPartNumber": { "type": "string" }, "sku": { "type": "string" }, "internalID": { "type": "string" }, "externalID": { "type": "string" }, "url": { "type": "string" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[ShippingTypeModel,ShippingType]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/ShippingTypeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[SkillModel,Skill]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SkillModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[SubscriptionPeriodModel,SubscriptionPeriod]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SubscriptionPeriodModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[SubscriptionModel,Subscription]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SubscriptionModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "SubscriptionModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "effectiveDate": { "format": "date-time", "type": "string" }, "expirationDate": { "format": "date-time", "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "materialCodeID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "periodCost": { "format": "double", "type": "number" }, "periodPrice": { "format": "double", "type": "number" }, "periodType": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "status": { "format": "int32", "type": "integer" }, "subscriptionName": { "type": "string" }, "totalCost": { "format": "double", "type": "number" }, "totalPrice": { "format": "double", "type": "number" }, "vendorID": { "format": "int32", "type": "integer" }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "QueryActionResult[SurveyResultsModel,SurveyResults]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SurveyResultsModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[SurveyModel,Survey]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/SurveyModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[TagAliasModel,TagAlias]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TagAliasModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TagAliasModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "alias": { "type": "string" }, "tagID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TagAlias,Int64]]", "readOnly": true } } }, "Expression[Func[TagAlias,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TagGroupModel,TagGroup]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TagGroupModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TagGroupModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "displayColor": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "label": { "type": "string" } } }, "QueryActionResult[TagModel,Tag]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TagModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TagModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "isActive": { "type": "boolean" }, "isExcludedFromAutomaticTagging": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "label": { "type": "string" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "tagGroupID": { "format": "int32", "type": "integer" } } }, "TaskAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "taskNoteID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "isTaskAttachment": { "type": "boolean", "readOnly": true }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "TaskNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isTaskAttachment": { "type": "boolean", "readOnly": true }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "taskNoteID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "QueryActionResult[TaskNoteModel,TaskNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaskNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaskNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "createdByContactID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "noteType": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TaskNote,Int64]]", "readOnly": true } } }, "Expression[Func[TaskNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TaskPredecessorModel,TaskPredecessor]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaskPredecessorModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaskPredecessorModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "lagDays": { "format": "int32", "type": "integer" }, "predecessorTaskID": { "format": "int32", "type": "integer" }, "successorTaskID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TaskPredecessor,Int64]]", "readOnly": true } } }, "Expression[Func[TaskPredecessor,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TaskModel,Task]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaskModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaskModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "assignedResourceID": { "format": "int32", "type": "integer" }, "assignedResourceRoleID": { "format": "int32", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "canClientPortalUserCompleteTask": { "type": "boolean" }, "companyLocationID": { "format": "int32", "type": "integer" }, "completedByResourceID": { "format": "int32", "type": "integer" }, "completedByType": { "format": "int32", "type": "integer" }, "completedDateTime": { "format": "date-time", "type": "string" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "creatorType": { "format": "int32", "type": "integer" }, "departmentID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "estimatedHours": { "format": "double", "type": "number" }, "externalID": { "type": "string" }, "hoursToBeScheduled": { "format": "double", "type": "number" }, "isTaskBillable": { "type": "boolean" }, "isVisibleInClientPortal": { "type": "boolean" }, "lastActivityDateTime": { "format": "date-time", "type": "string" }, "lastActivityPersonType": { "format": "int32", "type": "integer" }, "lastActivityResourceID": { "format": "int32", "type": "integer" }, "phaseID": { "format": "int32", "type": "integer" }, "priority": { "format": "int32", "type": "integer" }, "priorityLabel": { "format": "int32", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "remainingHours": { "format": "double", "type": "number" }, "startDateTime": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "taskCategoryID": { "format": "int32", "type": "integer" }, "taskNumber": { "type": "string" }, "taskType": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[Task,Int64]]", "readOnly": true }, "userDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[Task,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TaskSecondaryResourceModel,TaskSecondaryResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaskSecondaryResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaskSecondaryResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "roleID": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TaskSecondaryResource,Int64]]", "readOnly": true } } }, "Expression[Func[TaskSecondaryResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TaxCategoryModel,TaxCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaxCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaxCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[TaxModel,Tax]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaxModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaxModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isCompounded": { "type": "boolean" }, "taxCategoryID": { "format": "int32", "type": "integer" }, "taxName": { "type": "string" }, "taxRate": { "format": "double", "type": "number" }, "taxRegionID": { "format": "int32", "type": "integer" } } }, "QueryActionResult[TaxRegionModel,TaxRegion]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TaxRegionModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TaxRegionModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "QueryActionResult[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketAdditionalConfigurationItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketAdditionalConfigurationItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketAdditionalInstalledProduct,Int64]]", "readOnly": true } } }, "Expression[Func[TicketAdditionalInstalledProduct,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketAdditionalContactModel,TicketAdditionalContact]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketAdditionalContactModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketAdditionalContactModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "contactID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketAdditionalContact,Int64]]", "readOnly": true } } }, "Expression[Func[TicketAdditionalContact,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketCategoryModel,TicketCategory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketCategoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketCategoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "displayColorRGB": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isApiOnly": { "type": "boolean" }, "isGlobalDefault": { "type": "boolean" }, "name": { "type": "string" }, "nickname": { "type": "string" } } }, "QueryActionResult[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketCategoryFieldDefaultsModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketChangeRequestApprovalModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketChangeRequestApprovalModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approveRejectDateTime": { "format": "date-time", "type": "string" }, "approveRejectNote": { "type": "string" }, "contactID": { "format": "int32", "type": "integer" }, "isApproved": { "type": "boolean" }, "resourceID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketChangeRequestApproval,Int64]]", "readOnly": true } } }, "Expression[Func[TicketChangeRequestApproval,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketChargeModel,TicketCost]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketChargeModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketChargeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billableAmount": { "format": "double", "type": "number" }, "billingCodeID": { "format": "int64", "type": "integer" }, "chargeType": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int64", "type": "integer" }, "contractServiceID": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "creatorResourceID": { "format": "int64", "type": "integer" }, "datePurchased": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "extendedCost": { "format": "double", "type": "number" }, "internalCurrencyBillableAmount": { "format": "double", "type": "number" }, "internalCurrencyUnitPrice": { "format": "double", "type": "number" }, "internalPurchaseOrderNumber": { "type": "string" }, "isBillableToCompany": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "productID": { "format": "int64", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "status": { "format": "int64", "type": "integer" }, "statusLastModifiedBy": { "format": "int64", "type": "integer" }, "statusLastModifiedDate": { "format": "date-time", "type": "string" }, "ticketID": { "format": "int64", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "unitQuantity": { "format": "double", "type": "number" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketCost,Int64]]", "readOnly": true } } }, "Expression[Func[TicketCost,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketChecklistItemModel,TicketChecklistItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketChecklistItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketChecklistItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "completedByResourceID": { "format": "int32", "type": "integer" }, "completedDateTime": { "format": "date-time", "type": "string" }, "isCompleted": { "type": "boolean" }, "isImportant": { "type": "boolean" }, "itemName": { "type": "string" }, "knowledgebaseArticleID": { "format": "int32", "type": "integer" }, "position": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketChecklistItem,Int64]]", "readOnly": true } } }, "Expression[Func[TicketChecklistItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "TicketChecklistLibraryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "checklistLibraryID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketChecklistLibrary,Int64]]", "readOnly": true } } }, "Expression[Func[TicketChecklistLibrary,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketHistoryModel,TicketHistory]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketHistoryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketNoteAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "ticketNoteID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketNoteModel,TicketNote]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketNoteModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketNoteModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "createdByContactID": { "format": "int32", "type": "integer" }, "creatorResourceID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "noteType": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketNote,Int64]]", "readOnly": true } } }, "Expression[Func[TicketNote,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketNoteWebhookExcludedResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketNoteWebhookExcludedResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketNoteWebhookExcludedResource,Int64]]", "readOnly": true } } }, "Expression[Func[TicketNoteWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketNoteWebhookFieldModel,TicketNoteWebhookField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketNoteWebhookFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketNoteWebhookFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fieldID": { "format": "int32", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketNoteWebhookField,Int64]]", "readOnly": true } } }, "Expression[Func[TicketNoteWebhookField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketNoteWebhookModel,TicketNoteWebhook]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketNoteWebhookModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketNoteWebhookModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "deactivationUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isReady": { "type": "boolean" }, "isSubscribedToCreateEvents": { "type": "boolean" }, "isSubscribedToDeleteEvents": { "type": "boolean" }, "isSubscribedToUpdateEvents": { "type": "boolean" }, "name": { "type": "string" }, "notificationEmailAddress": { "type": "string" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "secretKey": { "type": "string" }, "sendThresholdExceededNotification": { "type": "boolean" }, "webhookGUID": { "type": "string" }, "webhookUrl": { "type": "string" } } }, "QueryActionResult[TicketRmaCreditModel,TicketRmaCredit]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketRmaCreditModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketRmaCreditModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "creditAmount": { "format": "double", "type": "number" }, "creditDetails": { "type": "string" }, "internalCurrencyCreditAmount": { "format": "double", "type": "number" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketRmaCredit,Int64]]", "readOnly": true } } }, "Expression[Func[TicketRmaCredit,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketModel,Ticket]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[TicketSecondaryResourceModel,TicketSecondaryResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketSecondaryResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketSecondaryResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int64", "type": "integer" }, "roleID": { "format": "int64", "type": "integer" }, "ticketID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketSecondaryResource,Int64]]", "readOnly": true } } }, "Expression[Func[TicketSecondaryResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketTagAssociationModel,TicketTagAssociation]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketTagAssociationModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketTagAssociationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "tagID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketTagAssociation,Int64]]", "readOnly": true } } }, "Expression[Func[TicketTagAssociation,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketWebhookExcludedResourceModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketWebhookExcludedResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketWebhookExcludedResource,Int64]]", "readOnly": true } } }, "Expression[Func[TicketWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketWebhookFieldModel,TicketWebhookField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketWebhookFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketWebhookFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "fieldID": { "format": "int32", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketWebhookField,Int64]]", "readOnly": true } } }, "Expression[Func[TicketWebhookField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TicketWebhookModel,TicketWebhook]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketWebhookModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketWebhookModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "deactivationUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isReady": { "type": "boolean" }, "isSubscribedToCreateEvents": { "type": "boolean" }, "isSubscribedToDeleteEvents": { "type": "boolean" }, "isSubscribedToUpdateEvents": { "type": "boolean" }, "name": { "type": "string" }, "notificationEmailAddress": { "type": "string" }, "ownerResourceID": { "format": "int32", "type": "integer" }, "secretKey": { "type": "string" }, "sendThresholdExceededNotification": { "type": "boolean" }, "webhookGUID": { "type": "string" }, "webhookUrl": { "type": "string" } } }, "QueryActionResult[TicketWebhookUdfFieldModel,TicketWebhookUdfField]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TicketWebhookUdfFieldModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TicketWebhookUdfFieldModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "isDisplayAlwaysField": { "type": "boolean" }, "isSubscribedField": { "type": "boolean" }, "udfFieldID": { "format": "int32", "type": "integer" }, "webhookID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TicketWebhookUdfField,Int64]]", "readOnly": true } } }, "Expression[Func[TicketWebhookUdfField,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TimeEntryModel,TimeEntry]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TimeEntryModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TimeEntryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingApprovalDateTime": { "format": "date-time", "type": "string" }, "billingApprovalLevelMostRecent": { "format": "int32", "type": "integer" }, "billingApprovalResourceID": { "format": "int32", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int64", "type": "integer" }, "contractServiceID": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "creatorUserID": { "format": "int32", "type": "integer" }, "dateWorked": { "format": "date-time", "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "hoursToBill": { "format": "double", "type": "number" }, "hoursWorked": { "format": "double", "type": "number" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "impersonatorUpdaterResourceID": { "format": "int32", "type": "integer" }, "internalBillingCodeID": { "format": "int32", "type": "integer" }, "internalNotes": { "type": "string" }, "isInternalNotesVisibleToComanaged": { "type": "boolean" }, "isNonBillable": { "type": "boolean" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "lastModifiedUserID": { "format": "int32", "type": "integer" }, "offsetHours": { "format": "double", "type": "number" }, "resourceID": { "format": "int32", "type": "integer" }, "roleID": { "format": "int32", "type": "integer" }, "showOnInvoice": { "type": "boolean" }, "startDateTime": { "format": "date-time", "type": "string" }, "summaryNotes": { "type": "string" }, "taskID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "timeEntryType": { "format": "int32", "type": "integer" } } }, "TimeEntryAttachmentModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "contentType": { "type": "string" }, "creatorType": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "data": { "format": "byte", "type": "string" }, "parentType": { "format": "int32", "type": "integer", "readOnly": true }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true }, "isTaskAttachment": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[TimeOffRequestModel,TimeOffRequest]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/TimeOffRequestModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "TimeOffRequestModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approvedDateTime": { "format": "date-time", "type": "string" }, "approveRejectResourceID": { "format": "int32", "type": "integer" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "endTime": { "format": "date-time", "type": "string" }, "hours": { "format": "double", "type": "number" }, "impersonatorApproveRejectResourceID": { "format": "int32", "type": "integer" }, "lastModifiedByResourceID": { "format": "int32", "type": "integer" }, "lastModifiedDateTime": { "format": "date-time", "type": "string" }, "lastApprovedLevel": { "format": "int32", "type": "integer" }, "reason": { "type": "string" }, "rejectReason": { "type": "string" }, "requestDate": { "format": "date-time", "type": "string" }, "resourceID": { "format": "int32", "type": "integer" }, "startTime": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "timeOffRequestType": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TimeOffRequest,Int64]]", "readOnly": true } } }, "Expression[Func[TimeOffRequest,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "TimeOffRequestRejectModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "timeOffRequestID": { "format": "int32", "type": "integer" }, "reason": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[TimeOffRequestReject,Int64]]", "readOnly": true } } }, "Expression[Func[TimeOffRequestReject,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[UserDefinedFieldDefinitionModel,UserDefinedFieldDefinition]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedFieldDefinitionModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "UserDefinedFieldDefinitionModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "crmToProjectUdfId": { "format": "int64", "type": "integer" }, "dataType": { "format": "int32", "type": "integer" }, "defaultValue": { "type": "object" }, "description": { "type": "string" }, "displayFormat": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isEncrypted": { "type": "boolean" }, "isFieldMapping": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isProtected": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isVisibleToClientPortal": { "type": "boolean" }, "mergeVariableName": { "type": "string" }, "name": { "type": "string" }, "numberOfDecimalPlaces": { "format": "int32", "type": "integer" }, "sortOrder": { "format": "int32", "type": "integer" }, "udfType": { "format": "int32", "type": "integer" } } }, "QueryActionResult[UserDefinedFieldListItemModel,UserDefinedFieldListItem]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedFieldListItemModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "UserDefinedFieldListItemModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDate": { "format": "date-time", "type": "string" }, "isActive": { "type": "boolean" }, "udfFieldId": { "format": "int64", "type": "integer" }, "valueForDisplay": { "type": "string" }, "valueForExport": { "type": "string" }, "soapParentPropertyId": { "$ref": "#/definitions/Expression[Func[UserDefinedFieldListItem,Int64]]", "readOnly": true } } }, "Expression[Func[UserDefinedFieldListItem,Int64]]": { "type": "object", "properties": { "type": { "type": "string", "readOnly": true }, "nodeType": { "enum": [ "Add", "AddChecked", "And", "AndAlso", "ArrayLength", "ArrayIndex", "Call", "Coalesce", "Conditional", "Constant", "Convert", "ConvertChecked", "Divide", "Equal", "ExclusiveOr", "GreaterThan", "GreaterThanOrEqual", "Invoke", "Lambda", "LeftShift", "LessThan", "LessThanOrEqual", "ListInit", "MemberAccess", "MemberInit", "Modulo", "Multiply", "MultiplyChecked", "Negate", "UnaryPlus", "NegateChecked", "New", "NewArrayInit", "NewArrayBounds", "Not", "NotEqual", "Or", "OrElse", "Parameter", "Power", "Quote", "RightShift", "Subtract", "SubtractChecked", "TypeAs", "TypeIs", "Assign", "Block", "DebugInfo", "Decrement", "Dynamic", "Default", "Extension", "Goto", "Increment", "Index", "Label", "RuntimeVariables", "Loop", "Switch", "Throw", "Try", "Unbox", "AddAssign", "AndAssign", "DivideAssign", "ExclusiveOrAssign", "LeftShiftAssign", "ModuloAssign", "MultiplyAssign", "OrAssign", "PowerAssign", "RightShiftAssign", "SubtractAssign", "AddAssignChecked", "MultiplyAssignChecked", "SubtractAssignChecked", "PreIncrementAssign", "PreDecrementAssign", "PostIncrementAssign", "PostDecrementAssign", "TypeEqual", "OnesComplement", "IsTrue", "IsFalse" ], "type": "string", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterExpression" }, "readOnly": true }, "name": { "type": "string", "readOnly": true }, "body": { "$ref": "#/definitions/Expression", "readOnly": true }, "returnType": { "type": "string", "readOnly": true }, "tailCall": { "type": "boolean", "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } } }, "QueryActionResult[WebhookEventErrorLogModel,WebhookEventErrorLog]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WebhookEventErrorLogModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "QueryActionResult[WorkTypeModifierModel,WorkTypeModifier]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/WorkTypeModifierModel" } }, "pageDetails": { "$ref": "#/definitions/PagingModel" } } }, "WorkTypeModifierModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "modifierType": { "format": "int32", "type": "integer" }, "modifierValue": { "format": "double", "type": "number" } } }, "Filter": { "type": "object", "properties": { "op": { "type": "string" }, "field": { "type": "string" }, "udf": { "type": "boolean" }, "value": { "description": "Can be either an Integer, String, Boolean, an Array of Integers, or an Array of Strings. ", "type": "object", "properties": {} }, "items": { "description": "An Array of Filter objects", "type": "array", "items": { "$ref": "#/definitions/Filter" } } } }, "ValueItem": { "type": "object", "properties": { "elementList": { "type": "array", "items": { "$ref": "#/definitions/CollectionItem" } }, "boolValue": { "type": "boolean" }, "longValue": { "format": "int64", "type": "integer" }, "stringValue": { "type": "string" } } }, "CollectionItem": { "type": "object", "properties": { "longValue": { "format": "int64", "type": "integer" }, "stringValue": { "type": "string" } } }, "PagingModel": { "type": "object", "properties": { "count": { "format": "int32", "type": "integer" }, "requestCount": { "format": "int32", "type": "integer", "readOnly": true }, "prevPageUrl": { "type": "string" }, "nextPageUrl": { "type": "string" } } }, "ItemQueryResultModel[ActionTypeModel,ActionType]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ActionTypeModel" } } }, "ItemQueryResultModel[AdditionalInvoiceFieldValueModel,AdditionalInvoiceFieldValue]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/AdditionalInvoiceFieldValueModel" } } }, "ItemQueryResultModel[AppointmentModel,Appointment]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/AppointmentModel" } } }, "ItemQueryResultModel[ArticleConfigurationItemCategoryAssociationModel,ArticleInstalledProductCategoryAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleConfigurationItemCategoryAssociationModel" } } }, "ItemQueryResultModel[ArticleNoteModel,ArticleNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleNoteModel" } } }, "ItemQueryResultModel[ArticlePlainTextContentModel,ArticlePlainTextContent]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticlePlainTextContentModel" } } }, "ItemQueryResultModel[ArticleTagAssociationModel,ArticleTagAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleTagAssociationModel" } } }, "ItemQueryResultModel[ArticleTicketAssociationModel,ArticleTicketAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleTicketAssociationModel" } } }, "ItemQueryResultModel[ArticleToArticleAssociationModel,ArticleToArticleAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleToArticleAssociationModel" } } }, "ItemQueryResultModel[ArticleToDocumentAssociationModel,ArticleToDocumentAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ArticleToDocumentAssociationModel" } } }, "ItemQueryResultModel[AttachmentInfoModel,AttachmentInfo]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/AttachmentInfoModel" } } }, "ItemQueryResultModel[BillingCodeModel,AllocationCode]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/BillingCodeModel" } } }, "ItemQueryResultModel[BillingItemApprovalLevelModel,BillingItemApprovalLevel]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/BillingItemApprovalLevelModel" } } }, "ItemQueryResultModel[BillingItemModel,BillingItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/BillingItemModel" } } }, "ItemQueryResultModel[ChangeOrderChargeModel,ChangeOrderCost]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ChangeOrderChargeModel" } } }, "ItemQueryResultModel[ChangeRequestLinkModel,ChangeRequestLink]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ChangeRequestLinkModel" } } }, "ItemQueryResultModel[ChecklistLibraryModel,ChecklistLibrary]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ChecklistLibraryModel" } } }, "ItemQueryResultModel[ChecklistLibraryChecklistItemModel,ChecklistLibraryChecklistItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ChecklistLibraryChecklistItemModel" } } }, "ItemQueryResultModel[ClassificationIconModel,ClassificationIcon]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ClassificationIconModel" } } }, "ItemQueryResultModel[ClientPortalUserModel,ClientPortalUser]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ClientPortalUserModel" } } }, "ItemQueryResultModel[ComanagedAssociationModel,ComanagedAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ComanagedAssociationModel" } } }, "ItemQueryResultModel[CompanyModel,Account]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyModel" } } }, "ItemQueryResultModel[CompanyAlertModel,AccountAlert]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyAlertModel" } } }, "ItemQueryResultModel[CompanyCategoryModel,AccountCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyCategoryModel" } } }, "ItemQueryResultModel[ContactModel,Contact]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactModel" } } }, "ItemQueryResultModel[CompanyLocationModel,AccountPhysicalLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyLocationModel" } } }, "ItemQueryResultModel[CompanyNoteModel,AccountNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyNoteModel" } } }, "ItemQueryResultModel[CompanySiteConfigurationModel,AccountLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanySiteConfigurationModel" } } }, "ItemQueryResultModel[CompanyTeamModel,AccountTeam]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyTeamModel" } } }, "ItemQueryResultModel[CompanyToDoModel,AccountToDo]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyToDoModel" } } }, "ItemQueryResultModel[CompanyWebhookExcludedResourceModel,AccountWebhookExcludedResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyWebhookExcludedResourceModel" } } }, "ItemQueryResultModel[CompanyWebhookFieldModel,AccountWebhookField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyWebhookFieldModel" } } }, "ItemQueryResultModel[CompanyWebhookModel,AccountWebhook]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyWebhookModel" } } }, "ItemQueryResultModel[CompanyWebhookUdfFieldModel,AccountWebhookUdfField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CompanyWebhookUdfFieldModel" } } }, "ItemQueryResultModel[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemBillingProductAssociationModel" } } }, "ItemQueryResultModel[ConfigurationItemCategoryModel,InstalledProductCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemCategoryModel" } } }, "ItemQueryResultModel[ConfigurationItemCategoryUdfAssociationModel,InstalledProductCategoryUdfAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemCategoryUdfAssociationModel" } } }, "ItemQueryResultModel[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemDnsRecordModel" } } }, "ItemQueryResultModel[ConfigurationItemNoteModel,InstalledProductNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemNoteModel" } } }, "ItemQueryResultModel[ConfigurationItemRelatedItemModel,InstalledProductRelatedItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemRelatedItemModel" } } }, "ItemQueryResultModel[ConfigurationItemModel,InstalledProduct]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemModel" } } }, "ItemQueryResultModel[ConfigurationItemSslSubjectAlternativeNameModel,InstalledProductSslSubjectAlternativeName]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemSslSubjectAlternativeNameModel" } } }, "ItemQueryResultModel[ConfigurationItemTypeModel,InstalledProductType]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemTypeModel" } } }, "ItemQueryResultModel[ConfigurationItemWebhookExcludedResourceModel,InstalledProductWebhookExcludedResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemWebhookExcludedResourceModel" } } }, "ItemQueryResultModel[ConfigurationItemWebhookFieldModel,InstalledProductWebhookField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemWebhookFieldModel" } } }, "ItemQueryResultModel[ConfigurationItemWebhookModel,InstalledProductWebhook]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemWebhookModel" } } }, "ItemQueryResultModel[ConfigurationItemWebhookUdfFieldModel,InstalledProductWebhookUdfField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ConfigurationItemWebhookUdfFieldModel" } } }, "ItemQueryResultModel[ContactBillingProductAssociationModel,ContactBillingProductAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactBillingProductAssociationModel" } } }, "ItemQueryResultModel[ContactGroupContactModel,ContactGroupContact]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactGroupContactModel" } } }, "ItemQueryResultModel[ContactGroupModel,ContactGroup]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactGroupModel" } } }, "ItemQueryResultModel[ContactWebhookExcludedResourceModel,ContactWebhookExcludedResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactWebhookExcludedResourceModel" } } }, "ItemQueryResultModel[ContactWebhookFieldModel,ContactWebhookField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactWebhookFieldModel" } } }, "ItemQueryResultModel[ContactWebhookModel,ContactWebhook]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactWebhookModel" } } }, "ItemQueryResultModel[ContactWebhookUdfFieldModel,ContactWebhookUdfField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContactWebhookUdfFieldModel" } } }, "ItemQueryResultModel[ContractBillingRuleModel,ContractBillingRule]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractBillingRuleModel" } } }, "ItemQueryResultModel[ContractBlockHourFactorModel,ContractFactor]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractBlockHourFactorModel" } } }, "ItemQueryResultModel[ContractBlockModel,ContractBlock]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractBlockModel" } } }, "ItemQueryResultModel[ContractChargeModel,ContractCost]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractChargeModel" } } }, "ItemQueryResultModel[ContractExclusionBillingCodeModel,ContractExclusionAllocationCode]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractExclusionBillingCodeModel" } } }, "ItemQueryResultModel[ContractExclusionRoleModel,ContractExclusionRole]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractExclusionRoleModel" } } }, "ItemQueryResultModel[ContractExclusionSetExcludedRoleModel,ContractExclusionSetExcludedRole]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractExclusionSetExcludedRoleModel" } } }, "ItemQueryResultModel[ContractExclusionSetExcludedWorkTypeModel,ContractExclusionSetExcludedWorkType]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractExclusionSetExcludedWorkTypeModel" } } }, "ItemQueryResultModel[ContractExclusionSetModel,ContractExclusionSet]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractExclusionSetModel" } } }, "ItemQueryResultModel[ContractMilestoneModel,ContractMilestone]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractMilestoneModel" } } }, "ItemQueryResultModel[ContractNoteModel,ContractNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractNoteModel" } } }, "ItemQueryResultModel[ContractRateModel,ContractRate]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractRateModel" } } }, "ItemQueryResultModel[ContractRetainerModel,ContractRetainer]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractRetainerModel" } } }, "ItemQueryResultModel[ContractRoleCostModel,ContractRoleCost]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractRoleCostModel" } } }, "ItemQueryResultModel[ContractModel,Contract]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractModel" } } }, "ItemQueryResultModel[ContractServiceBundleModel,ContractServiceBundle]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractServiceBundleModel" } } }, "ItemQueryResultModel[ContractServiceBundleUnitModel,ContractServiceBundleUnit]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractServiceBundleUnitModel" } } }, "ItemQueryResultModel[ContractServiceModel,ContractService]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractServiceModel" } } }, "ItemQueryResultModel[ContractServiceUnitModel,ContractServiceUnit]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractServiceUnitModel" } } }, "ItemQueryResultModel[ContractTicketPurchaseModel,ContractTicketPurchase]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ContractTicketPurchaseModel" } } }, "ItemQueryResultModel[CountryModel,Country]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CountryModel" } } }, "ItemQueryResultModel[CurrencyModel,Currency]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/CurrencyModel" } } }, "ItemQueryResultModel[DeletedTaskActivityLogModel,DeletedTaskActivityLog]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DeletedTaskActivityLogModel" } } }, "ItemQueryResultModel[DeletedTicketActivityLogModel,DeletedTicketActivityLog]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DeletedTicketActivityLogModel" } } }, "ItemQueryResultModel[DeletedTicketLogModel,DeletedTicketLog]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DeletedTicketLogModel" } } }, "ItemQueryResultModel[DepartmentModel,Department]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DepartmentModel" } } }, "ItemQueryResultModel[DocumentCategoryModel,DocumentCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentCategoryModel" } } }, "ItemQueryResultModel[DocumentChecklistItemModel,DocumentChecklistItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentChecklistItemModel" } } }, "ItemQueryResultModel[DocumentConfigurationItemAssociationModel,DocumentInstalledProductAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentConfigurationItemAssociationModel" } } }, "ItemQueryResultModel[DocumentConfigurationItemCategoryAssociationModel,DocumentInstalledProductCategoryAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentConfigurationItemCategoryAssociationModel" } } }, "ItemQueryResultModel[DocumentNoteModel,DocumentNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentNoteModel" } } }, "ItemQueryResultModel[DocumentPlainTextContentModel,DocumentPlainTextContent]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentPlainTextContentModel" } } }, "ItemQueryResultModel[DocumentModel,Document]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentModel" } } }, "ItemQueryResultModel[DocumentTagAssociationModel,DocumentTagAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentTagAssociationModel" } } }, "ItemQueryResultModel[DocumentTicketAssociationModel,DocumentTicketAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentTicketAssociationModel" } } }, "ItemQueryResultModel[DocumentToArticleAssociationModel,DocumentToArticleAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentToArticleAssociationModel" } } }, "ItemQueryResultModel[DocumentToDocumentAssociationModel,DocumentToDocumentAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DocumentToDocumentAssociationModel" } } }, "ItemQueryResultModel[DomainRegistrarModel,DomainRegistrar]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/DomainRegistrarModel" } } }, "ItemQueryResultModel[ExpenseItemModel,ExpenseItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ExpenseItemModel" } } }, "ItemQueryResultModel[ExpenseReportModel,ExpenseReport]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ExpenseReportModel" } } }, "ItemQueryResultModel[HolidayModel,Holiday]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/HolidayModel" } } }, "ItemQueryResultModel[HolidaySetModel,HolidaySet]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/HolidaySetModel" } } }, "ItemQueryResultModel[IntegrationVendorInsightModel,IntegrationVendorInsight]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/IntegrationVendorInsightModel" } } }, "ItemQueryResultModel[IntegrationVendorWidgetModel,IntegrationVendorWidget]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/IntegrationVendorWidgetModel" } } }, "ItemQueryResultModel[InternalLocationModel,InternalLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InternalLocationModel" } } }, "ItemQueryResultModel[InternalLocationWithBusinessHoursModel,BusinessLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InternalLocationWithBusinessHoursModel" } } }, "ItemQueryResultModel[InventoryItemModel,InventoryItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryItemModel" } } }, "ItemQueryResultModel[InventoryItemSerialNumberModel,InventoryItemSerialNumber]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryItemSerialNumberModel" } } }, "ItemQueryResultModel[InventoryLocationModel,InventoryLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryLocationModel" } } }, "ItemQueryResultModel[InventoryProductModel,InventoryProduct]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryProductModel" } } }, "ItemQueryResultModel[InventoryStockedItemModel,InventoryStockedItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryStockedItemModel" } } }, "ItemQueryResultModel[InventoryTransferModel,InventoryTransfer]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InventoryTransferModel" } } }, "ItemQueryResultModel[InvoiceModel,Invoice]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InvoiceModel" } } }, "ItemQueryResultModel[InvoiceTemplateModel,InvoiceTemplate]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/InvoiceTemplateModel" } } }, "ItemQueryResultModel[KnowledgeBaseArticleModel,KnowledgeBaseArticle]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/KnowledgeBaseArticleModel" } } }, "ItemQueryResultModel[KnowledgeBaseCategoryModel,KnowledgeBaseCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/KnowledgeBaseCategoryModel" } } }, "ItemQueryResultModel[NotificationHistoryModel,NotificationHistory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/NotificationHistoryModel" } } }, "ItemQueryResultModel[OpportunityModel,Opportunity]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OpportunityModel" } } }, "ItemQueryResultModel[OpportunityCategoryModel,OpportunityCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OpportunityCategoryModel" } } }, "ItemQueryResultModel[OrganizationalLevel1Model,BusinessDivision]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OrganizationalLevel1Model" } } }, "ItemQueryResultModel[OrganizationalLevel2Model,BusinessSubdivision]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OrganizationalLevel2Model" } } }, "ItemQueryResultModel[OrganizationalLevelAssociationModel,BusinessDivisionSubdivision]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OrganizationalLevelAssociationModel" } } }, "ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OrganizationalResourceModel" } } }, "ItemQueryResultModel[PaymentTermModel,PaymentTerm]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PaymentTermModel" } } }, "ItemQueryResultModel[PhaseModel,Phase]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PhaseModel" } } }, "ItemQueryResultModel[PriceListMaterialCodeModel,PriceListMaterialCode]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListMaterialCodeModel" } } }, "ItemQueryResultModel[PriceListProductModel,PriceListProduct]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListProductModel" } } }, "ItemQueryResultModel[PriceListProductTierModel,PriceListProductTier]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListProductTierModel" } } }, "ItemQueryResultModel[PriceListRoleModel,PriceListRole]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListRoleModel" } } }, "ItemQueryResultModel[PriceListServiceBundleModel,PriceListServiceBundle]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListServiceBundleModel" } } }, "ItemQueryResultModel[PriceListServiceModel,PriceListService]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListServiceModel" } } }, "ItemQueryResultModel[PriceListWorkTypeModifierModel,PriceListWorkTypeModifier]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PriceListWorkTypeModifierModel" } } }, "ItemQueryResultModel[ProductNoteModel,ProductNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProductNoteModel" } } }, "ItemQueryResultModel[ProductModel,Product]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProductModel" } } }, "ItemQueryResultModel[ProductTierModel,ProductTier]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProductTierModel" } } }, "ItemQueryResultModel[ProductVendorModel,ProductVendor]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProductVendorModel" } } }, "ItemQueryResultModel[ProjectChargeModel,ProjectCost]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProjectChargeModel" } } }, "ItemQueryResultModel[ProjectNoteModel,ProjectNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProjectNoteModel" } } }, "ItemQueryResultModel[ProjectModel,Project]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ProjectModel" } } }, "ItemQueryResultModel[PurchaseApprovalModel,PurchaseApproval]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PurchaseApprovalModel" } } }, "ItemQueryResultModel[PurchaseOrderItemReceivingModel,PurchaseOrderReceive]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PurchaseOrderItemReceivingModel" } } }, "ItemQueryResultModel[PurchaseOrderItemModel,PurchaseOrderItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PurchaseOrderItemModel" } } }, "ItemQueryResultModel[PurchaseOrderModel,PurchaseOrder]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/PurchaseOrderModel" } } }, "ItemQueryResultModel[QuoteItemModel,QuoteItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/QuoteItemModel" } } }, "ItemQueryResultModel[QuoteLocationModel,QuoteLocation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/QuoteLocationModel" } } }, "ItemQueryResultModel[QuoteModel,Quote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/QuoteModel" } } }, "ItemQueryResultModel[QuoteTemplateModel,QuoteTemplate]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/QuoteTemplateModel" } } }, "ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceDailyAvailabilityModel" } } }, "ItemQueryResultModel[ResourceRoleDepartmentModel,ResourceRoleDepartment]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceRoleDepartmentModel" } } }, "ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceRoleQueueModel" } } }, "ItemQueryResultModel[ResourceRoleModel,ResourceRole]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceRoleModel" } } }, "ItemQueryResultModel[ResourceModel,Resource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceModel" } } }, "ItemQueryResultModel[ResourceServiceDeskRoleModel,ResourceServiceDeskRole]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceServiceDeskRoleModel" } } }, "ItemQueryResultModel[ResourceSkillModel,ResourceSkill]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceSkillModel" } } }, "ItemQueryResultModel[ResourceTimeOffAdditionalModel,ResourceTimeOffAdditional]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceTimeOffAdditionalModel" } } }, "ItemQueryResultModel[ResourceTimeOffApproverModel,ResourceTimeOffApprover]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceTimeOffApproverModel" } } }, "ItemQueryResultModel[ResourceTimeOffBalanceModel,ResourceTimeOffBalance]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ResourceTimeOffBalanceModel" } } }, "ItemQueryResultModel[RoleModel,Role]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/RoleModel" } } }, "ItemQueryResultModel[SalesOrderModel,SalesOrder]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SalesOrderModel" } } }, "ItemQueryResultModel[ServiceBundleModel,ServiceBundle]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceBundleModel" } } }, "ItemQueryResultModel[ServiceBundleServiceModel,ServiceBundleService]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceBundleServiceModel" } } }, "ItemQueryResultModel[ServiceCallModel,ServiceCall]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceCallModel" } } }, "ItemQueryResultModel[ServiceCallTaskResourceModel,ServiceCallTaskResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceCallTaskResourceModel" } } }, "ItemQueryResultModel[ServiceCallTaskModel,ServiceCallTask]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceCallTaskModel" } } }, "ItemQueryResultModel[ServiceCallTicketResourceModel,ServiceCallTicketResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceCallTicketResourceModel" } } }, "ItemQueryResultModel[ServiceCallTicketModel,ServiceCallTicket]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceCallTicketModel" } } }, "ItemQueryResultModel[ServiceLevelAgreementResultsModel,ServiceLevelAgreementResults]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceLevelAgreementResultsModel" } } }, "ItemQueryResultModel[ServiceModel,Service]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ServiceModel" } } }, "ItemQueryResultModel[ShippingTypeModel,ShippingType]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/ShippingTypeModel" } } }, "ItemQueryResultModel[SkillModel,Skill]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SkillModel" } } }, "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SubscriptionPeriodModel" } } }, "ItemQueryResultModel[SubscriptionModel,Subscription]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SubscriptionModel" } } }, "ItemQueryResultModel[SurveyResultsModel,SurveyResults]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SurveyResultsModel" } } }, "ItemQueryResultModel[SurveyModel,Survey]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/SurveyModel" } } }, "ItemQueryResultModel[TagAliasModel,TagAlias]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TagAliasModel" } } }, "ItemQueryResultModel[TagGroupModel,TagGroup]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TagGroupModel" } } }, "ItemQueryResultModel[TagModel,Tag]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TagModel" } } }, "ItemQueryResultModel[TaskNoteModel,TaskNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaskNoteModel" } } }, "ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaskPredecessorModel" } } }, "ItemQueryResultModel[TaskModel,Task]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaskModel" } } }, "ItemQueryResultModel[TaskSecondaryResourceModel,TaskSecondaryResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaskSecondaryResourceModel" } } }, "ItemQueryResultModel[TaxCategoryModel,TaxCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaxCategoryModel" } } }, "ItemQueryResultModel[TaxModel,Tax]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaxModel" } } }, "ItemQueryResultModel[TaxRegionModel,TaxRegion]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TaxRegionModel" } } }, "ItemQueryResultModel[TicketAdditionalConfigurationItemModel,TicketAdditionalInstalledProduct]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketAdditionalConfigurationItemModel" } } }, "ItemQueryResultModel[TicketAdditionalContactModel,TicketAdditionalContact]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketAdditionalContactModel" } } }, "ItemQueryResultModel[TicketCategoryModel,TicketCategory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketCategoryModel" } } }, "ItemQueryResultModel[TicketCategoryFieldDefaultsModel,TicketCategoryFieldDefaults]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketCategoryFieldDefaultsModel" } } }, "ItemQueryResultModel[TicketChangeRequestApprovalModel,TicketChangeRequestApproval]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketChangeRequestApprovalModel" } } }, "ItemQueryResultModel[TicketChargeModel,TicketCost]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketChargeModel" } } }, "ItemQueryResultModel[TicketChecklistItemModel,TicketChecklistItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketChecklistItemModel" } } }, "ItemQueryResultModel[TicketHistoryModel,TicketHistory]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketHistoryModel" } } }, "ItemQueryResultModel[TicketNoteModel,TicketNote]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketNoteModel" } } }, "ItemQueryResultModel[TicketNoteWebhookExcludedResourceModel,TicketNoteWebhookExcludedResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketNoteWebhookExcludedResourceModel" } } }, "ItemQueryResultModel[TicketNoteWebhookFieldModel,TicketNoteWebhookField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketNoteWebhookFieldModel" } } }, "ItemQueryResultModel[TicketNoteWebhookModel,TicketNoteWebhook]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketNoteWebhookModel" } } }, "ItemQueryResultModel[TicketRmaCreditModel,TicketRmaCredit]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketRmaCreditModel" } } }, "ItemQueryResultModel[TicketModel,Ticket]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketModel" } } }, "ItemQueryResultModel[TicketSecondaryResourceModel,TicketSecondaryResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketSecondaryResourceModel" } } }, "ItemQueryResultModel[TicketTagAssociationModel,TicketTagAssociation]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketTagAssociationModel" } } }, "ItemQueryResultModel[TicketWebhookExcludedResourceModel,TicketWebhookExcludedResource]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketWebhookExcludedResourceModel" } } }, "ItemQueryResultModel[TicketWebhookFieldModel,TicketWebhookField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketWebhookFieldModel" } } }, "ItemQueryResultModel[TicketWebhookModel,TicketWebhook]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketWebhookModel" } } }, "ItemQueryResultModel[TicketWebhookUdfFieldModel,TicketWebhookUdfField]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TicketWebhookUdfFieldModel" } } }, "ItemQueryResultModel[TimeEntryModel,TimeEntry]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TimeEntryModel" } } }, "ItemQueryResultModel[TimeOffRequestModel,TimeOffRequest]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/TimeOffRequestModel" } } }, "ItemQueryResultModel[UserDefinedFieldDefinitionModel,UserDefinedFieldDefinition]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/UserDefinedFieldDefinitionModel" } } }, "ItemQueryResultModel[UserDefinedFieldListItemModel,UserDefinedFieldListItem]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/UserDefinedFieldListItemModel" } } }, "ItemQueryResultModel[WebhookEventErrorLogModel,WebhookEventErrorLog]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/WebhookEventErrorLogModel" } } }, "ItemQueryResultModel[WorkTypeModifierModel,WorkTypeModifier]": { "type": "object", "properties": { "item": { "$ref": "#/definitions/WorkTypeModifierModel" } } }, "AdditionalInvoiceFieldValueModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalInvoiceFieldID": { "format": "int64", "type": "integer" }, "fieldValue": { "type": "string" }, "invoiceBatchID": { "format": "int64", "type": "integer" } } }, "AttachmentInfoModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "articleID": { "format": "int32", "type": "integer" }, "attachDate": { "format": "date-time", "type": "string" }, "attachedByContactID": { "format": "int64", "type": "integer" }, "attachedByResourceID": { "format": "int64", "type": "integer" }, "attachmentType": { "type": "string" }, "companyID": { "format": "int32", "type": "integer" }, "companyNoteID": { "format": "int32", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "configurationItemNoteID": { "format": "int32", "type": "integer" }, "contentType": { "type": "string" }, "contractID": { "format": "int32", "type": "integer" }, "contractNoteID": { "format": "int32", "type": "integer" }, "creatorType": { "format": "int32", "type": "integer" }, "documentID": { "format": "int32", "type": "integer" }, "expenseItemID": { "format": "int32", "type": "integer" }, "expenseReportID": { "format": "int32", "type": "integer" }, "fileSize": { "format": "double", "type": "number" }, "fullPath": { "type": "string" }, "impersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "opportunityID": { "format": "int64", "type": "integer" }, "parentAttachmentID": { "format": "int32", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" }, "parentType": { "format": "int32", "type": "integer" }, "projectID": { "format": "int32", "type": "integer" }, "projectNoteID": { "format": "int32", "type": "integer" }, "publish": { "format": "int32", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "salesOrderID": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "taskNoteID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "ticketNoteID": { "format": "int32", "type": "integer" }, "timeEntryID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "BillingCodeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "afterHoursWorkType": { "format": "int32", "type": "integer" }, "billingCodeType": { "format": "int32", "type": "integer" }, "department": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "externalNumber": { "type": "string" }, "generalLedgerAccount": { "format": "int32", "type": "integer" }, "isActive": { "type": "boolean" }, "isExcludedFromNewContracts": { "type": "boolean" }, "markupRate": { "format": "double", "type": "number" }, "name": { "type": "string" }, "taxCategoryID": { "format": "int32", "type": "integer" }, "unitCost": { "format": "double", "type": "number" }, "unitPrice": { "format": "double", "type": "number" }, "useType": { "format": "int32", "type": "integer" } } }, "ClassificationIconModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "name": { "type": "string" }, "relativeUrl": { "type": "string" } } }, "ConfigurationItemDnsRecordModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "data": { "type": "string" }, "installedProductID": { "format": "int32", "type": "integer" }, "timeToLiveSeconds": { "format": "int32", "type": "integer" }, "dnsType": { "type": "string" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ConfigurationItemSslSubjectAlternativeNameModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "configurationItemID": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ContractServiceBundleUnitModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approveAndPostDate": { "format": "date-time", "type": "string" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceBundleID": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "endDate": { "format": "date-time", "type": "string" }, "internalCurrencyPrice": { "format": "double", "type": "number" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "price": { "format": "double", "type": "number" }, "serviceBundleID": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "units": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ContractServiceUnitModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "approveAndPostDate": { "format": "date-time", "type": "string" }, "contractID": { "format": "int32", "type": "integer" }, "contractServiceID": { "format": "int32", "type": "integer" }, "cost": { "format": "double", "type": "number" }, "endDate": { "format": "date-time", "type": "string" }, "internalCurrencyPrice": { "format": "double", "type": "number" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "price": { "format": "double", "type": "number" }, "serviceID": { "format": "int32", "type": "integer" }, "startDate": { "format": "date-time", "type": "string" }, "units": { "format": "int32", "type": "integer" }, "vendorCompanyID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "DeletedTaskActivityLogModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "typeID": { "format": "int32", "type": "integer" }, "taskID": { "format": "int32", "type": "integer" }, "taskNumber": { "type": "string" }, "noteOrAttachmentTitle": { "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "activityDateTime": { "format": "date-time", "type": "string" }, "startDateTime": { "format": "date-time", "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "hoursWorked": { "format": "double", "type": "number" }, "deletedByResourceID": { "format": "int32", "type": "integer" }, "deletedDateTime": { "format": "date-time", "type": "string" } } }, "DeletedTicketActivityLogModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "typeID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "ticketNumber": { "type": "string" }, "noteOrAttachmentTitle": { "type": "string" }, "createdByResourceID": { "format": "int32", "type": "integer" }, "activityDateTime": { "format": "date-time", "type": "string" }, "startDateTime": { "format": "date-time", "type": "string" }, "endDateTime": { "format": "date-time", "type": "string" }, "hoursWorked": { "format": "double", "type": "number" }, "deletedByResourceID": { "format": "int32", "type": "integer" }, "deletedDateTime": { "format": "date-time", "type": "string" } } }, "DeletedTicketLogModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "ticketNumber": { "type": "string" }, "ticketTitle": { "type": "string" }, "deletedByResourceID": { "format": "int32", "type": "integer" }, "deletedDateTime": { "format": "date-time", "type": "string" } } }, "InternalLocationModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "additionalAddressInfo": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "holidaySetId": { "format": "int64", "type": "integer" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "timeZone": { "type": "string" } } }, "InvoiceTemplateModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "coveredByBlockRetainerContractLabel": { "type": "string" }, "coveredByRecurringServiceFixedPricePerTicketContractLabel": { "type": "string" }, "currencyNegativeFormat": { "type": "string" }, "currencyPositiveFormat": { "type": "string" }, "dateFormat": { "format": "int32", "type": "integer" }, "displayFixedPriceContractLabor": { "type": "boolean" }, "displayRecurringServiceContractLabor": { "type": "boolean" }, "displaySeparateLineItemForEachTax": { "type": "boolean" }, "displayTaxCategory": { "type": "boolean" }, "displayTaxCategorySuperscripts": { "type": "boolean" }, "displayZeroAmountRecurringServicesAndBundles": { "type": "boolean" }, "groupBy": { "format": "int32", "type": "integer" }, "itemizeItemsInEachGroup": { "format": "int32", "type": "integer" }, "itemizeServicesAndBundles": { "type": "boolean" }, "name": { "type": "string" }, "nonBillableLaborLabel": { "type": "string" }, "numberFormat": { "format": "int32", "type": "integer" }, "pageLayout": { "format": "int32", "type": "integer" }, "pageNumberFormat": { "format": "int32", "type": "integer" }, "paymentTerms": { "format": "int32", "type": "integer" }, "rateCostExpression": { "type": "string" }, "showGridHeader": { "type": "boolean" }, "showVerticalGridLines": { "type": "boolean" }, "sortBy": { "format": "int32", "type": "integer" }, "timeFormat": { "format": "int32", "type": "integer" } } }, "NotificationHistoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int64", "type": "integer" }, "entityNumber": { "type": "string" }, "entityTitle": { "type": "string" }, "initiatingContactID": { "format": "int64", "type": "integer" }, "initiatingResourceID": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "isTemplateJob": { "type": "boolean" }, "notificationHistoryTypeID": { "format": "int32", "type": "integer" }, "notificationSentTime": { "format": "date-time", "type": "string" }, "opportunityID": { "format": "int64", "type": "integer" }, "projectID": { "format": "int64", "type": "integer" }, "quoteID": { "format": "int64", "type": "integer" }, "recipientDisplayName": { "type": "string" }, "recipientEmailAddress": { "type": "string" }, "taskID": { "format": "int64", "type": "integer" }, "templateName": { "type": "string" }, "ticketID": { "format": "int64", "type": "integer" }, "timeEntryID": { "format": "int64", "type": "integer" } } }, "OrganizationalResourceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "QuoteTemplateModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "calculateTaxSeparately": { "type": "boolean" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "format": "int32", "type": "integer" }, "currencyNegativeFormat": { "type": "string" }, "currencyPositiveFormat": { "type": "string" }, "dateFormat": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "displayTaxCategorySuperscripts": { "type": "boolean" }, "isActive": { "type": "boolean" }, "lastActivityBy": { "format": "int32", "type": "integer" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "numberFormat": { "format": "int32", "type": "integer" }, "pageLayout": { "format": "int32", "type": "integer" }, "pageNumberFormat": { "format": "int32", "type": "integer" }, "showEachTaxInGroup": { "type": "boolean" }, "showGridHeader": { "type": "boolean" }, "showTaxCategory": { "type": "boolean" }, "showVerticalGridLines": { "type": "boolean" } } }, "ResourceRoleModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "departmentID": { "format": "int64", "type": "integer" }, "isActive": { "type": "boolean" }, "queueID": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int64", "type": "integer" }, "roleID": { "format": "int64", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ResourceTimeOffApproverModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "approverResourceID": { "format": "int32", "type": "integer" }, "approvalLevel": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ResourceTimeOffBalanceModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "resourceID": { "format": "int32", "type": "integer" }, "floatingHolidayAnnualAllowance": { "format": "double", "type": "number" }, "floatingHolidayBalance": { "format": "double", "type": "number" }, "floatingHolidayPlanned": { "format": "double", "type": "number" }, "floatingHolidayUsed": { "format": "double", "type": "number" }, "floatingHolidayWaitingApproval": { "format": "double", "type": "number" }, "personalTimeAnnualAllowance": { "format": "double", "type": "number" }, "personalTimeBalance": { "format": "double", "type": "number" }, "personalTimePlanned": { "format": "double", "type": "number" }, "personalTimeUsed": { "format": "double", "type": "number" }, "personalTimeWaitingApproval": { "format": "double", "type": "number" }, "sickTimeAnnualAllowance": { "format": "double", "type": "number" }, "sickTimeBalance": { "format": "double", "type": "number" }, "sickTimePlanned": { "format": "double", "type": "number" }, "sickTimeUsed": { "format": "double", "type": "number" }, "sickTimeWaitingApproval": { "format": "double", "type": "number" }, "vacationTimeAnnualAllowance": { "format": "double", "type": "number" }, "vacationTimeBalance": { "format": "double", "type": "number" }, "vacationTimePlanned": { "format": "double", "type": "number" }, "vacationTimeUsed": { "format": "double", "type": "number" }, "vacationTimeWaitingApproval": { "format": "double", "type": "number" }, "year": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ServiceLevelAgreementResultsModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "firstResponseElapsedHours": { "format": "double", "type": "number" }, "firstResponseInitiatingResourceID": { "format": "int32", "type": "integer" }, "firstResponseResourceID": { "format": "int32", "type": "integer" }, "isFirstResponseMet": { "type": "boolean" }, "isResolutionMet": { "type": "boolean" }, "isResolutionPlanMet": { "type": "boolean" }, "resolutionElapsedHours": { "format": "double", "type": "number" }, "resolutionPlanElapsedHours": { "format": "double", "type": "number" }, "resolutionPlanResourceID": { "format": "int32", "type": "integer" }, "resolutionResourceID": { "format": "int32", "type": "integer" }, "serviceLevelAgreementName": { "type": "string" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "ShippingTypeModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "billingCodeID": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "SkillModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "categoryID": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" } } }, "SubscriptionPeriodModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "periodCost": { "format": "double", "type": "number" }, "periodDate": { "format": "date-time", "type": "string" }, "periodPrice": { "format": "double", "type": "number" }, "postedDate": { "format": "date-time", "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "subscriptionID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "SurveyResultsModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "companyID": { "format": "int32", "type": "integer" }, "companyRating": { "format": "double", "type": "number" }, "completeDate": { "format": "date-time", "type": "string" }, "contactID": { "format": "int32", "type": "integer" }, "contactRating": { "format": "double", "type": "number" }, "resourceRating": { "format": "double", "type": "number" }, "sendDate": { "format": "date-time", "type": "string" }, "surveyID": { "format": "int32", "type": "integer" }, "surveyRating": { "format": "double", "type": "number" }, "ticketID": { "format": "int32", "type": "integer" } } }, "SurveyModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "TicketCategoryFieldDefaultsModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "estimatedHours": { "format": "double", "type": "number" }, "issueTypeID": { "format": "int32", "type": "integer" }, "organizationalLevelAssociationID": { "format": "int32", "type": "integer" }, "priority": { "format": "int32", "type": "integer" }, "purchaseOrderNumber": { "type": "string" }, "queueID": { "format": "int32", "type": "integer" }, "resolution": { "type": "string" }, "serviceLevelAgreementID": { "format": "int32", "type": "integer" }, "sourceID": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "subIssueTypeID": { "format": "int32", "type": "integer" }, "ticketCategoryID": { "format": "int32", "type": "integer" }, "ticketTypeID": { "format": "int32", "type": "integer" }, "title": { "type": "string" }, "workTypeID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "TicketHistoryModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "action": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "detail": { "type": "string" }, "resourceID": { "format": "int32", "type": "integer" }, "ticketID": { "format": "int32", "type": "integer" }, "soapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true } } }, "WebhookEventErrorLogModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "accountWebhookID": { "format": "int32", "type": "integer" }, "contactWebhookID": { "format": "int32", "type": "integer" }, "createDateTime": { "format": "date-time", "type": "string" }, "errorMessage": { "type": "string" }, "payload": { "type": "string" }, "sequenceNumber": { "format": "int32", "type": "integer" } } }, "AccountInvoiceSettingsResultModel": { "type": "object", "properties": { "taxExempt": { "type": "boolean" }, "taxRegionId": { "format": "int32", "type": "integer" }, "taxId": { "type": "string" }, "invoiceEmailingEnabled": { "type": "boolean" }, "contactRecipients": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "resourceRecipients": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "otherEmails": { "type": "string" } } }, "OperationResultModel": { "type": "object", "properties": { "itemId": { "$ref": "#/definitions/Object" } } }, "Object": { "type": "object", "properties": {} }, "AddContactRecipientsResultModel": { "type": "object", "properties": { "contactRecipients": { "type": "array", "items": { "format": "int32", "type": "integer", "readOnly": true } } } }, "AddResourceRecipientsResultModel": { "type": "object", "properties": { "resourceRecipients": { "type": "array", "items": { "format": "int32", "type": "integer", "readOnly": true } } } }, "QueryCountResultModel": { "type": "object", "properties": { "queryCount": { "format": "int32", "type": "integer" } } }, "EntityInformationResultModel": { "type": "object", "properties": { "info": { "$ref": "#/definitions/EntityInformationModel", "readOnly": true } } }, "EntityInformationModel": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true }, "canCreate": { "type": "boolean", "readOnly": true }, "canDelete": { "type": "boolean", "readOnly": true }, "canQuery": { "type": "boolean", "readOnly": true }, "canUpdate": { "type": "boolean", "readOnly": true }, "userAccessForCreate": { "$ref": "#/definitions/RestUserAccessLevel", "readOnly": true }, "userAccessForDelete": { "$ref": "#/definitions/RestUserAccessLevel", "readOnly": true }, "userAccessForQuery": { "$ref": "#/definitions/RestUserAccessLevel", "readOnly": true }, "userAccessForUpdate": { "$ref": "#/definitions/RestUserAccessLevel", "readOnly": true }, "hasUserDefinedFields": { "type": "boolean", "readOnly": true }, "supportsWebhookCallouts": { "type": "boolean", "readOnly": true } } }, "RestUserAccessLevel": { "type": "object", "properties": {} }, "FieldInformationResultModel": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/FieldInformationModel", "readOnly": true } } } }, "FieldInformationModel": { "type": "object", "properties": { "name": { "type": "string" }, "dataType": { "type": "string" }, "length": { "format": "int32", "type": "integer" }, "isRequired": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQueryable": { "type": "boolean" }, "isReference": { "type": "boolean" }, "referenceEntityType": { "type": "string" }, "isPickList": { "type": "boolean" }, "picklistValues": { "type": "array", "items": { "$ref": "#/definitions/PickListValue" } }, "picklistParentValueField": { "type": "string" }, "isSupportedWebhookField": { "$ref": "#/definitions/Object" } } }, "PickListValue": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "isDefaultValue": { "type": "boolean" }, "sortOrder": { "format": "int32", "type": "integer" }, "parentValue": { "type": "string" }, "isActive": { "type": "boolean" }, "isSystem": { "type": "boolean" } } }, "UserDefinedFieldInformationResultModel": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/definitions/Field", "readOnly": true } } } }, "Field": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "length": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "isRequired": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQueryable": { "type": "boolean" }, "isReference": { "type": "boolean" }, "referenceEntityType": { "type": "string" }, "isPickList": { "type": "boolean" }, "picklistValues": { "type": "array", "items": { "$ref": "#/definitions/PickListValue" } }, "picklistParentValueField": { "type": "string" }, "defaultValue": { "type": "string" }, "isSupportedWebhookField": { "$ref": "#/definitions/Object" } } }, "ApiVersionResultModel": { "type": "object", "properties": { "apiVersions": { "type": "array", "items": { "type": "string", "readOnly": true } } } }, "AuthTokenResultModel": { "type": "object", "properties": { "authToken": { "type": "string", "readOnly": true }, "expiration": { "format": "date-time", "type": "string", "readOnly": true } } }, "AutotaskVersionResultModel": { "type": "object", "properties": { "majorVersion": { "type": "string", "readOnly": true }, "minorVersion": { "type": "string", "readOnly": true }, "build": { "type": "string", "readOnly": true }, "customerType": { "type": "string", "readOnly": true } } }, "InvoiceMarkupResultModel": { "type": "object", "properties": { "invoiceMarkup": { "type": "string" } } }, "FileQueryResultModel": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "contentType": { "type": "string", "readOnly": true }, "fileName": { "type": "string", "readOnly": true }, "fileSize": { "format": "int32", "type": "integer", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/definitions/Byte", "readOnly": true } } } }, "Byte": { "type": "object", "properties": {} }, "GlobalEntityInformationResultModel": { "type": "object", "properties": { "entityDescriptions": { "type": "array", "items": { "$ref": "#/definitions/EntityInformationResultModel", "readOnly": true } } } }, "ModuleAccessResultModel": { "type": "object", "properties": { "modules": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair`2" } } } }, "KeyValuePair`2": { "type": "object", "properties": { "key": { "format": "int32", "type": "integer", "readOnly": true }, "value": { "type": "boolean", "readOnly": true } } }, "ThresholdStatusResultModel": { "type": "object", "properties": { "externalRequestThreshold": { "format": "int32", "type": "integer", "readOnly": true }, "requestThresholdTimeframe": { "format": "int32", "type": "integer", "readOnly": true }, "currentTimeframeRequestCount": { "format": "int32", "type": "integer", "readOnly": true } } }, "ZoneInformationResultModel": { "type": "object", "properties": { "zoneName": { "type": "string", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "webUrl": { "type": "string", "readOnly": true }, "ci": { "format": "int32", "type": "integer", "readOnly": true } } } } }