v1.json
{
"swagger": "2.0", "info": { "version": "v1", "title": "Datto|Autotask PSA Rest API" }, "host": "webservices2.autotask.net", "basePath": "/ATServicesRest", "schemes": [ "https" ], "paths": { "/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/ActionTypeModel" } }, "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/ActionTypeModel" } }, "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/ActionTypeModel" } }, "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/ActionTypeModel" } }, "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/ActionTypeModel" } }, "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/ActionTypeModel" } }, "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/AdditionalInvoiceFieldValueModel" } }, "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/AdditionalInvoiceFieldValueModel" } }, "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/AdditionalInvoiceFieldValueModel" } }, "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/AppointmentModel" } }, "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/AppointmentModel" } }, "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/AppointmentModel" } }, "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/AppointmentModel" } }, "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/AppointmentModel" } }, "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/AppointmentModel" } }, "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/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/AttachmentInfoModel" } }, "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/AttachmentInfoModel" } }, "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/AttachmentInfoModel" } }, "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/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/BillingCodeModel" } }, "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/BillingCodeModel" } }, "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/BillingCodeModel" } }, "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/BillingItemApprovalLevelModel" } }, "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/BillingItemApprovalLevelModel" } }, "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/BillingItemApprovalLevelModel" } }, "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/BillingItemApprovalLevelModel" } }, "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/BillingItemModel" } }, "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/BillingItemModel" } }, "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/BillingItemModel" } }, "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/BillingItemModel" } }, "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/BillingItemModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeOrderChargeModel" } }, "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/ChangeRequestLinkModel" } }, "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/ChangeRequestLinkModel" } }, "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/ChangeRequestLinkModel" } }, "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/ChangeRequestLinkModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ChecklistLibraryChecklistItemModel" } }, "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/ClassificationIconModel" } }, "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/ClassificationIconModel" } }, "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/ClassificationIconModel" } }, "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/ClientPortalUserModel" } }, "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/ClientPortalUserModel" } }, "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/ClientPortalUserModel" } }, "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/ClientPortalUserModel" } }, "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/ClientPortalUserModel" } }, "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/ClientPortalUserModel" } }, "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/ComanagedAssociationModel" } }, "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/ComanagedAssociationModel" } }, "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/ComanagedAssociationModel" } }, "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": { "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/ComanagedAssociationModel" } }, "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/CompanyModel" } }, "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/CompanyModel" } }, "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/CompanyModel" } }, "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/CompanyModel" } }, "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/CompanyModel" } }, "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/CompanyModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAlertModel" } }, "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/CompanyAttachmentModel" } }, "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/OperationResultModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/CompanyLocationModel" } }, "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/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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanyNoteModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanySiteConfigurationModel" } }, "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/CompanyTeamModel" } }, "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/CompanyTeamModel" } }, "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/CompanyTeamModel" } }, "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/CompanyTeamModel" } }, "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/CompanyTeamModel" } }, "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/CompanyTeamModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyToDoModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookExcludedResourceModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookFieldModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/CompanyWebhookUdfFieldModel" } }, "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/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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemBillingProductAssociationModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemCategoryUdfAssociationModel" } }, "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/ConfigurationItemExts": { "put": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_UpdateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_CreateEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_PatchEntity", "consumes": [ "application/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "restModelInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, { "name": "ApiIntegrationCode", "in": "header", "description": "API Integration Code", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User Name", "required": true, "type": "string" }, { "name": "Secret", "in": "header", "description": "Secret", "required": true, "type": "string" }, { "name": "ImpersonationResourceId", "in": "header", "description": "Impersonation Resource Key", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigurationItemExtModel" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/V1.0/ConfigurationItemExts/entityInformation": { "get": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_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/ConfigurationItemExts/entityInformation/fields": { "get": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_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/ConfigurationItemExts/entityInformation/userDefinedFields": { "get": { "tags": [ "ConfigurationItemExts" ], "operationId": "ConfigurationItemExts_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/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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/ConfigurationItemNoteModel" } }, "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/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/ConfigurationItemModel" } }, "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/ConfigurationItemModel" } }, "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/ConfigurationItemModel" } }, "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/ConfigurationItemModel" } }, "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/ConfigurationItemModel" } }, "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/ConfigurationItemModel" } }, "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/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/ConfigurationItemTypeModel" } }, "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/ConfigurationItemTypeModel" } }, "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/ConfigurationItemTypeModel" } }, "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/ConfigurationItemTypeModel" } }, "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/ConfigurationItemTypeModel" } }, "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/ConfigurationItemTypeModel" } }, "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/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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactBillingProductAssociationModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupContactModel" } }, "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/ContactGroupModel" } }, "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/ContactGroupModel" } }, "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/ContactGroupModel" } }, "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/ContactGroupModel" } }, "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/ContactGroupModel" } }, "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/ContactGroupModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/ContactModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookExcludedResourceModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookFieldModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContactWebhookUdfFieldModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBillingRuleModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockHourFactorModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractBlockModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractChargeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionBillingCodeModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedRoleModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetExcludedWorkTypeModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractExclusionSetModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/ContractMilestoneModel" } }, "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/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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractNoteModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRateModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRetainerModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractRoleCostModel" } }, "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/ContractModel" } }, "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/ContractModel" } }, "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/ContractModel" } }, "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/ContractModel" } }, "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/ContractModel" } }, "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/ContractModel" } }, "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/ContractServiceAdjustmentModel" } }, "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/ContractServiceAdjustmentModel" } }, "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/ContractServiceBundleAdjustmentModel" } }, "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/ContractServiceBundleAdjustmentModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleModel" } }, "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/ContractServiceBundleUnitModel" } }, "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/ContractServiceBundleUnitModel" } }, "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/ContractServiceBundleUnitModel" } }, "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/ContractServiceBundleUnitModel" } }, "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/ContractServiceBundleUnitModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceModel" } }, "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/ContractServiceUnitModel" } }, "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/ContractServiceUnitModel" } }, "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/ContractServiceUnitModel" } }, "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/ContractServiceUnitModel" } }, "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/ContractServiceUnitModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/ContractTicketPurchaseModel" } }, "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/CountryModel" } }, "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/CountryModel" } }, "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/CountryModel" } }, "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/CountryModel" } }, "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/CountryModel" } }, "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/CurrencyModel" } }, "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/CurrencyModel" } }, "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/CurrencyModel" } }, "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/CurrencyModel" } }, "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/CurrencyModel" } }, "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/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/DepartmentModel" } }, "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/DepartmentModel" } }, "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/DepartmentModel" } }, "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/DepartmentModel" } }, "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/DepartmentModel" } }, "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/DepartmentModel" } }, "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/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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/ExpenseItemModel" } }, "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/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/ExpenseReportModel" } }, "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/ExpenseReportModel" } }, "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/ExpenseReportModel" } }, "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/ExpenseReportModel" } }, "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/ExpenseReportModel" } }, "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/ExpenseReportModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidayModel" } }, "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/HolidaySetModel" } }, "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/HolidaySetModel" } }, "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/HolidaySetModel" } }, "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/HolidaySetModel" } }, "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/HolidaySetModel" } }, "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/HolidaySetModel" } }, "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/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/InternalLocationModel" } }, "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/InternalLocationModel" } }, "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/InternalLocationModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InternalLocationWithBusinessHoursModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryItemSerialNumberModel" } }, "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/InventoryLocationModel" } }, "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/InventoryLocationModel" } }, "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/InventoryLocationModel" } }, "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/InventoryLocationModel" } }, "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/InventoryLocationModel" } }, "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/InventoryLocationModel" } }, "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/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/InventoryTransferModel" } }, "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/InventoryTransferModel" } }, "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/InventoryTransferModel" } }, "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/InventoryTransferModel" } }, "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/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/InvoiceModel" } }, "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/InvoiceModel" } }, "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/InvoiceModel" } }, "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/InvoiceModel" } }, "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/InvoiceModel" } }, "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/InvoiceTemplateModel" } }, "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/InvoiceTemplateModel" } }, "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/InvoiceTemplateModel" } }, "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/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/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/NotificationHistoryModel" } }, "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/NotificationHistoryModel" } }, "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/NotificationHistoryModel" } }, "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/OpportunityModel" } }, "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/OpportunityModel" } }, "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/OpportunityModel" } }, "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/OpportunityModel" } }, "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/OpportunityModel" } }, "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/OpportunityModel" } }, "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/OpportunityAttachmentModel" } }, "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/OperationResultModel" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel1Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevel2Model" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalLevelAssociationModel" } }, "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/OrganizationalResourceModel" } }, "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/OrganizationalResourceModel" } }, "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/OrganizationalResourceModel" } }, "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/OrganizationalResourceModel" } }, "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/OrganizationalResourceModel" } }, "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/PaymentTermModel" } }, "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/PaymentTermModel" } }, "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/PaymentTermModel" } }, "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/PaymentTermModel" } }, "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/PaymentTermModel" } }, "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/PaymentTermModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PhaseModel" } }, "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/PriceListMaterialCodeModel" } }, "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/PriceListMaterialCodeModel" } }, "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/PriceListMaterialCodeModel" } }, "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/PriceListMaterialCodeModel" } }, "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/PriceListMaterialCodeModel" } }, "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/PriceListProductModel" } }, "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/PriceListProductModel" } }, "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/PriceListProductModel" } }, "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/PriceListProductModel" } }, "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/PriceListProductModel" } }, "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/PriceListProductTierModel" } }, "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/PriceListProductTierModel" } }, "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/PriceListProductTierModel" } }, "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/PriceListProductTierModel" } }, "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/PriceListProductTierModel" } }, "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/PriceListRoleModel" } }, "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/PriceListRoleModel" } }, "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/PriceListRoleModel" } }, "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/PriceListRoleModel" } }, "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/PriceListRoleModel" } }, "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/PriceListServiceBundleModel" } }, "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/PriceListServiceBundleModel" } }, "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/PriceListServiceBundleModel" } }, "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/PriceListServiceBundleModel" } }, "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/PriceListServiceBundleModel" } }, "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/PriceListServiceModel" } }, "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/PriceListServiceModel" } }, "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/PriceListServiceModel" } }, "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/PriceListServiceModel" } }, "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/PriceListServiceModel" } }, "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/PriceListWorkTypeModifierModel" } }, "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/PriceListWorkTypeModifierModel" } }, "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/PriceListWorkTypeModifierModel" } }, "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/PriceListWorkTypeModifierModel" } }, "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/PriceListWorkTypeModifierModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductNoteModel" } }, "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/ProductModel" } }, "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/ProductModel" } }, "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/ProductModel" } }, "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/ProductModel" } }, "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/ProductModel" } }, "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/ProductModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductTierModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProductVendorModel" } }, "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/ProjectAttachmentModel" } }, "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/OperationResultModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/ProjectChargeModel" } }, "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/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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectNoteModel" } }, "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/ProjectModel" } }, "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/ProjectModel" } }, "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/ProjectModel" } }, "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/ProjectModel" } }, "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/ProjectModel" } }, "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/ProjectModel" } }, "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/PurchaseApprovalModel" } }, "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/PurchaseApprovalModel" } }, "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/PurchaseApprovalModel" } }, "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/PurchaseApprovalModel" } }, "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/PurchaseApprovalModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemReceivingModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderItemModel" } }, "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/PurchaseOrderModel" } }, "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/PurchaseOrderModel" } }, "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/PurchaseOrderModel" } }, "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/PurchaseOrderModel" } }, "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/PurchaseOrderModel" } }, "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/PurchaseOrderModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteItemModel" } }, "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/QuoteLocationModel" } }, "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/QuoteLocationModel" } }, "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/QuoteLocationModel" } }, "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/QuoteLocationModel" } }, "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/QuoteLocationModel" } }, "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/QuoteLocationModel" } }, "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/QuoteModel" } }, "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/QuoteModel" } }, "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/QuoteModel" } }, "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/QuoteModel" } }, "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/QuoteModel" } }, "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/QuoteModel" } }, "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/QuoteTemplateModel" } }, "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/QuoteTemplateModel" } }, "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/QuoteTemplateModel" } }, "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/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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleDepartmentModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleQueueModel" } }, "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/ResourceRoleModel" } }, "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/ResourceRoleModel" } }, "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/ResourceRoleModel" } }, "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/ResourceRoleModel" } }, "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/ResourceRoleModel" } }, "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/ResourceModel" } }, "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/ResourceModel" } }, "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/ResourceModel" } }, "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/ResourceModel" } }, "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/ResourceModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceServiceDeskRoleModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/ResourceSkillModel" } }, "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/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/RoleModel" } }, "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/RoleModel" } }, "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/RoleModel" } }, "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/RoleModel" } }, "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/RoleModel" } }, "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/RoleModel" } }, "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/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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/SalesOrderModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceBundleServiceModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskResourceModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTaskModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketResourceModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceCallTicketModel" } }, "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/ServiceLevelAgreementResultsModel" } }, "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/ServiceLevelAgreementResultsModel" } }, "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/ServiceLevelAgreementResultsModel" } }, "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/ServiceLevelAgreementResultsModel" } }, "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/ServiceLevelAgreementResultsModel" } }, "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/ServiceModel" } }, "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/ServiceModel" } }, "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/ServiceModel" } }, "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/ServiceModel" } }, "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/ServiceModel" } }, "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/ServiceModel" } }, "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/ShippingTypeModel" } }, "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/ShippingTypeModel" } }, "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/ShippingTypeModel" } }, "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/SkillModel" } }, "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/SkillModel" } }, "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/SkillModel" } }, "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/SubscriptionPeriodModel" } }, "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/SubscriptionPeriodModel" } }, "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/SubscriptionPeriodModel" } }, "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/SubscriptionPeriodModel" } }, "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/SubscriptionPeriodModel" } }, "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/SubscriptionModel" } }, "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/SubscriptionModel" } }, "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/SubscriptionModel" } }, "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/SubscriptionModel" } }, "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/SubscriptionModel" } }, "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/SubscriptionModel" } }, "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/SurveyResultsModel" } }, "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/SurveyResultsModel" } }, "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/SurveyResultsModel" } }, "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/SurveyModel" } }, "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/SurveyModel" } }, "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/SurveyModel" } }, "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/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/TaskAttachmentModel" } }, "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/OperationResultModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskNoteModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskPredecessorModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaskSecondaryResourceModel" } }, "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/TaxCategoryModel" } }, "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/TaxCategoryModel" } }, "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/TaxCategoryModel" } }, "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/TaxCategoryModel" } }, "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/TaxCategoryModel" } }, "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/TaxCategoryModel" } }, "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/TaxModel" } }, "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/TaxModel" } }, "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/TaxModel" } }, "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/TaxModel" } }, "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/TaxModel" } }, "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/TaxModel" } }, "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/TaxRegionModel" } }, "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/TaxRegionModel" } }, "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/TaxRegionModel" } }, "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/TaxRegionModel" } }, "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/TaxRegionModel" } }, "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/TaxRegionModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalConfigurationItemModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAdditionalContactModel" } }, "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/TicketAttachmentModel" } }, "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/OperationResultModel" } }, "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/TicketCategoryModel" } }, "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/TicketCategoryModel" } }, "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/TicketCategoryModel" } }, "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/TicketCategoryModel" } }, "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/TicketCategoryModel" } }, "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/TicketCategoryFieldDefaultsModel" } }, "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/TicketCategoryFieldDefaultsModel" } }, "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/TicketCategoryFieldDefaultsModel" } }, "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/TicketCategoryFieldDefaultsModel" } }, "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/TicketCategoryFieldDefaultsModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChangeRequestApprovalModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChargeModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistItemModel" } }, "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/TicketChecklistLibraryModel" } }, "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/TicketChecklistLibraryModel" } }, "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/TicketHistoryModel" } }, "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/TicketHistoryModel" } }, "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/TicketHistoryModel" } }, "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/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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/TicketNoteModel" } }, "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/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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketRmaCreditModel" } }, "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/TicketModel" } }, "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/TicketModel" } }, "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/TicketModel" } }, "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/TicketModel" } }, "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/TicketModel" } }, "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/TicketModel" } }, "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/TicketSecondaryResourceModel" } }, "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/TicketSecondaryResourceModel" } }, "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/TicketSecondaryResourceModel" } }, "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/TicketSecondaryResourceModel" } }, "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/TicketSecondaryResourceModel" } }, "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/TicketSecondaryResourceModel" } }, "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/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/TimeEntryModel" } }, "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/TimeEntryModel" } }, "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/TimeEntryModel" } }, "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/TimeEntryModel" } }, "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/TimeEntryModel" } }, "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/TimeEntryModel" } }, "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/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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldDefinitionModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/UserDefinedFieldListItemModel" } }, "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/WebhookEventErrorLogModel" } }, "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/WebhookEventErrorLogModel" } }, "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/WebhookEventErrorLogModel" } }, "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/WorkTypeModifierModel" } }, "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/WorkTypeModifierModel" } }, "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/WorkTypeModifierModel" } }, "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/WorkTypeModifierModel" } }, "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/WorkTypeModifierModel" } }, "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": { "QueryModel": { "type": "object", "properties": { "MaxRecords": { "format": "int32", "type": "integer" }, "IncludeFields": { "type": "array", "items": { "type": "string" } }, "Filter": { "type": "array", "items": { "$ref": "#/definitions/Filter" } }, "Xml": { "type": "string" } } }, "OperationActionResult": { "type": "object", "properties": {} }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "UserDefinedField": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "BillingItemModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "AccountManagerWhenApprovedID": { "format": "int32", "type": "integer" }, "BillingCodeID": { "format": "int32", "type": "integer" }, "BillingItemType": { "format": "int32", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "ConfigurationItemID": { "format": "int64", "type": "integer" }, "ContractChargeID": { "format": "int64", "type": "integer" }, "ContractID": { "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" }, "LineItemID": { "format": "int64", "type": "integer" }, "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" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ChangeRequestLinkModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "ChangeRequestTicketID": { "format": "int32", "type": "integer" }, "ProblemOrIncidentTicketID": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ChecklistLibraryModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "EntityType": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ChecklistLibraryChecklistItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "readOnly": true }, "Name": { "type": "string", "readOnly": true }, "IsByRef": { "type": "boolean", "readOnly": true }, "CanReduce": { "type": "boolean", "readOnly": true } } }, "Expression": { "type": "object", "properties": { "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "readOnly": true }, "Type": { "type": "string", "readOnly": true }, "CanReduce": { "type": "boolean", "readOnly": true } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ComanagedAssociationModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "ResourceID": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "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" }, "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" }, "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" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountAlert,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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" }, "ContentType": { "type": "string" }, "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 }, "IsTaskAttachment": { "type": "boolean", "readOnly": true }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "Expression[Func[AttachmentInfo,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "OverrideAccountTaxSettings": { "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountPhysicalLocation,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountTeam,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountToDo,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountWebhookField,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[AccountWebhookUdfField,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[InstalledProductBillingProductAssociation,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[InstalledProductCategoryUdfAssociation,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "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" }, "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" }, "VendorID": { "format": "int32", "type": "integer" }, "WarrantyExpirationDate": { "format": "date-time", "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[InstalledProductNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "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" }, "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" }, "VendorID": { "format": "int32", "type": "integer" }, "WarrantyExpirationDate": { "format": "date-time", "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ConfigurationItemTypeModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContactBillingProductAssociation,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContactGroupContact,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "ContactGroupModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "IsActive": { "type": "boolean" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContactWebhookExcludedResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContactWebhookField,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContactWebhookUdfField,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractBillingRule,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "ContractBlockHourFactorModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "BlockHourMultiplier": { "format": "double", "type": "number" }, "ContractID": { "format": "int32", "type": "integer" }, "RoleID": { "format": "int32", "type": "integer" }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[ContractFactor,Int64]]", "readOnly": true }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractFactor,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractBlock,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractCost,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractExclusionAllocationCode,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractExclusionRole,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractExclusionSetExcludedRole,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractExclusionSetExcludedWorkType,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "ContractExclusionSetModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractMilestone,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractRate,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractRetainer,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractRoleCost,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractServiceAdjustment,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractServiceBundleAdjustment,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractServiceBundle,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractService,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ContractTicketPurchase,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "QuoteTemplateID": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "DepartmentModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "Name": { "type": "string" }, "Number": { "type": "string" }, "PrimaryLocationID": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ExpenseItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[Holiday,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "HolidaySetModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "HolidaySetDescription": { "type": "string" }, "HolidaySetName": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "InventoryItemSerialNumberModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "InventoryItemID": { "format": "int64", "type": "integer" }, "SerialNumber": { "type": "string" }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[InventoryItemSerialNumber,Int64]]", "readOnly": true }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[InventoryItemSerialNumber,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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": "int32", "type": "integer" }, "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" }, "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 }, "IsTaskAttachment": { "type": "boolean", "readOnly": true }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "OrganizationalLevel1Model": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "OrganizationalLevel2Model": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "OrganizationalLevelAssociationModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "IsActive": { "type": "boolean" }, "OrganizationalLevel1ID": { "format": "int32", "type": "integer" }, "OrganizationalLevel2ID": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "PaymentTermModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "PaymentDueInDays": { "format": "int32", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[Phase,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[PriceListProductTier,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ProductNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "ProductModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "BillingType": { "format": "int32", "type": "integer" }, "ChargeBillingCodeID": { "format": "int32", "type": "integer" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ProductTier,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ProductVendor,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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" }, "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 }, "IsTaskAttachment": { "type": "boolean", "readOnly": true }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ProjectCost,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "ProjectNoteModel": { "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" }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ProjectNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" } } } }, "PurchaseApprovalModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "CostType": { "type": "string" }, "IsApproved": { "type": "boolean" }, "RejectNote": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[PurchaseOrderReceive,Int64]]", "readOnly": true }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[PurchaseOrderReceive,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[PurchaseOrderItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[QuoteItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "QuoteLocationModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Address1": { "type": "string" }, "Address2": { "type": "string" }, "City": { "type": "string" }, "PostalCode": { "type": "string" }, "State": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ResourceRoleDepartment,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ResourceRoleQueue,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ResourceServiceDeskRole,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ResourceSkill,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ServiceBundleService,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ServiceCallTaskResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ServiceCallTask,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ServiceCallTicketResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[ServiceCallTicket,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" } } } }, "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" }, "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" }, "IsTaskAttachment": { "type": "boolean", "readOnly": true }, "ParentType": { "format": "int32", "type": "integer", "readOnly": true }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "TaskNoteModel": { "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" }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TaskNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TaskPredecessor,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TaskSecondaryResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "TaxCategoryModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "TaxRegionModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketAdditionalInstalledProduct,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketAdditionalContact,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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 }, "IsTaskAttachment": { "type": "boolean", "readOnly": true }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[AttachmentInfo,Int64]]", "readOnly": true } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketChangeRequestApproval,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketCost,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketChecklistItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketChecklistLibrary,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "TicketNoteModel": { "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" }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketNote,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketRmaCredit,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "IssueType": { "format": "int32", "type": "integer" }, "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": "int32", "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" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[TicketSecondaryResource,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "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" }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "UserDefinedFieldListItemModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "CreateDate": { "format": "date-time", "type": "string" }, "UdfFieldId": { "format": "int64", "type": "integer" }, "ValueForDisplay": { "type": "string" }, "ValueForExport": { "type": "string" }, "SoapParentPropertyId": { "$ref": "#/definitions/Expression[Func[UserDefinedFieldListItem,Int64]]", "readOnly": true }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Expression[Func[UserDefinedFieldListItem,Int64]]": { "type": "object", "properties": { "Type": { "type": "string", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "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 } } }, "WorkTypeModifierModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "ModifierType": { "format": "int32", "type": "integer" }, "ModifierValue": { "format": "double", "type": "number" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "Filter": { "type": "object", "properties": { "op": { "type": "string" }, "field": { "type": "string" }, "udf": { "type": "boolean" }, "value": { "$ref": "#/definitions/ValueItem" }, "items": { "type": "array", "items": { "$ref": "#/definitions/Filter" } } } }, "ValueItem": { "type": "object", "properties": { "ElementList": { "type": "array", "items": { "$ref": "#/definitions/CollectionItem" } }, "BoolValue": { "type": "boolean" }, "IntegerValue": { "format": "int32", "type": "integer" }, "StringValue": { "type": "string" } } }, "CollectionItem": { "type": "object", "properties": { "IntegerValue": { "format": "int32", "type": "integer" }, "StringValue": { "type": "string" } } }, "OperationResultModel": { "type": "object", "properties": { "ItemId": { "$ref": "#/definitions/Object" } } }, "Object": { "type": "object", "properties": {} }, "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" } } }, "AdditionalInvoiceFieldValueModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "AdditionalInvoiceFieldID": { "format": "int64", "type": "integer" }, "FieldValue": { "type": "string" }, "InvoiceBatchID": { "format": "int64", "type": "integer" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ApiVersionResultModel": { "type": "object", "properties": { "ApiVersions": { "type": "array", "items": { "type": "string", "readOnly": true } } } }, "AttachmentInfoModel": { "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" }, "FileSize": { "format": "double", "type": "number" }, "FullPath": { "type": "string" }, "ImpersonatorCreatorResourceID": { "format": "int32", "type": "integer" }, "OpportunityID": { "format": "int64", "type": "integer" }, "ParentID": { "format": "int64", "type": "integer" }, "ParentType": { "format": "int32", "type": "integer" }, "Publish": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "SoapParentPropertyId": { "format": "int64", "type": "integer", "readOnly": true }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ClassificationIconModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "IsSystem": { "type": "boolean" }, "Name": { "type": "string" }, "RelativeUrl": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "GlobalEntityInformationResultModel": { "type": "object", "properties": { "EntityDescriptions": { "type": "array", "items": { "$ref": "#/definitions/EntityInformationResultModel", "readOnly": true } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "ShippingTypeModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "BillingCodeID": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "SkillModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "CategoryID": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "SurveyModel": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "Name": { "type": "string" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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" }, "UserDefinedFields": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedField" } } } }, "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 } } } } } |